✒️
Documentation API Engagement
Documentation Produit
Documentation Produit
  • INTRODUCTION
    • Qu'est ce que l'API Engagement ?
    • À qui s'adresse l'API Engagement ?
    • Comment devenir partenaire ?
  • ANNONCEUR
    • Partager des missions d'engagement
    • Étape 1 : créer d'un flux XML
      • Format du flux XML
      • Liste des champs à inclure dans le flux XML
      • Conditions d'utilisation du flux XML
    • Étape 2 : tracker des candidatures
      • Rajout de la balise et des commandes de tracking par le tag
      • Tracking de l'activité par API
    • Modération des missions partagées
      • Modération API Engagement
      • Modération des partenaires "diffuseur"
  • Diffuseur
    • Diffuser des missions d'engagement sur mon site
      • Diffuser des missions par API
      • Diffuser des missions par widget
      • Diffuser des missions par lien tracké
    • Modèle de données d'une mission d'engagement
    • Partager les données de diffusion sur mon site à l'API Engagement
      • Missions non diffusées sur mon site
      • Partager vos statistiques de diffusions (impressions) à l'API Engagement
        • Par envoi de fichier csv.
        • Par la mise en place d'un tag (ou pixel) sur votre site
      • Identifier l’origine d’une redirection à l’aide de tags
  • RESSOURCES
    • Traitement des données utilisateurs
Powered by GitBook
On this page
  • Étape 1 : Création d'une route "feedback" (à réaliser par l'équipe API Engagement)
  • Étape 2 : Envoyer l'information des missions non diffusées
  • GET /v2/{nom}/feedback
  1. Diffuseur
  2. Partager les données de diffusion sur mon site à l'API Engagement

Missions non diffusées sur mon site

Rappel : Cette section ne s'adresse qu'aux diffuseurs ayant choisi l'intégration par API.

Il est possible que certaines des missions présentes dans le flux API ne correspondent pas à vos critères pour être diffusées ; et que vous choissisez de ne pas les diffuser sur votre application. Cette information doit être partagée à l'API Engagement.

Étape 1 : Création d'une route "feedback" (à réaliser par l'équipe API Engagement)

  • Le chargé de déploiement avec qui vous êtes en contact se charge d'ouvrir et configurer la route (création de l’endpoint dans l’environnement adéquat) 

  • Cette route sera de la forme /v2/{nomPartenaire}/feedback

NB : Les données d'authenfication restent les mêmes que pour accéder aux données de missions.

Étape 2 : Envoyer l'information des missions non diffusées

GET /v2/{nom}/feedback

Header

Champs

Type

Description

Example

x-api-key

String

Clef API fournie

xxxxxxxx_xxxx_xxxx_xxxx_xxxxxxxxxxxx

Body


Champs

Type

Requis

Description

missionId

String

oui

ID de l'annonce

status

String

oui

ACCEPTED en cas d’ajout réussi

PENDING en cas de début de traitement de la mission (optionnel)

DELETED en cas de suppression réussie

REFUSED en cas de refus de la mission (accompagné de la raison dans le champs note

url

String

non

Url de l'annonce

comment

String

non

Détails de refus de la mission. Obligatoires pour les statuts REFUSED.

Exemples

Accepted

{
	"missionId": "5f6b4b86596993ec582f92d1", 
	"status": "ACCEPTED",
	"url": "<https://www.jobteaser.com/en/job-offers/xxx-ma-mission>"
}

Refused

{
	"missionId": "5f6b4b86596993ec582f92d1", 
	"status": "REFUSED",
	"comment": "La mission ne possede pas de code postal"
}

Responses

Status 200

{
	"ok": true
}

Status 400

{
    "ok": false,
    "code": "INVALID_BODY",
    "message": {
        "issues": [
            {
                "code": "invalid_type",
                "expected": "string",
                "received": "undefined",
                "path": [
                    "missionId"
                ],
                "message": "Required"
            }
        ],
        "name": "ZodError"
    }
}

Status 401

Unauthorized

Status 404

{
    "ok": false,
    "code": "NOT_FOUND",
    "message": "Mission not found"
}
PreviousPartager les données de diffusion sur mon site à l'API EngagementNextPartager vos statistiques de diffusions (impressions) à l'API Engagement

Last updated 4 months ago