✒️
Documentation API Engagement
API Reference
API Reference
  • API REFERENCE
    • Introduction
    • Authentification
    • Errors
  • MISSION (/mission)
    • Récupérer des missions
    • Rechercher dans les missions
    • Récupérer une mission avec l'identifiant
  • MES MISSIONS (/mymission)
    • Récupérer vos missions
    • Récupérer votre mission avec l'identifiant de la mission
    • Récupérer les statistiques d'une mission
  • PERFORMANCE (/view)
    • Récupérer des statistiques sur vos missions
  • DIFFUSEUR (/publisher)
    • Récupérer la liste de mes partenaires diffuseurs
    • Récupérer les informations d'un partenaire diffuseur avec son identifiant
  • MES ORGANISATIONS (/myorganization)
    • Récupérer la liste des partenaires diffuseurs pour une organisation
    • Modifier les partenaires diffuseurs d'une organisation
  • Organisation (/organization)
    • Récupérer les organisations
Powered by GitBook
On this page
  1. DIFFUSEUR (/publisher)

Récupérer les informations d'un partenaire diffuseur avec son identifiant

Récupérer les informations d'un partenaire diffuseur à partir de son identifiant

GET https://api.api-engagement.beta.gouv.fr/v0/publisher/:id

Path Parameters

Name
Type
Description

id

String

Identifiant du partenaire diffuseur

Headers

Name
Type
Description

x-api-key Requis

String

La clé API nécessaire à l’authentification. Les données disponibles sont définies en fonction de votre clé API.

Response

// GET /v0/publisher/partenaire_id_1
{
    "ok": true,
    "data": {
        "_id": "partenaire_id_1",
        "name": "Mon partenaire diffuseur 1",
        "category": "OTHER",
        "url": "https://www.partenaire1.fr",
        "logo": "https://api-engagement-bucket.s3.fr-par.scw.cloud/publishers/partenaire_id_1/logo",
        "description": "La description de mon partenaire",
        "widget": false, // Ne diffuse pas de missions par widget
        "api": true, // Diffuse des missions par API
        "campaign": true, // Diffuse par campagne
        "annonceur": true, // Est annonceur de missions
        "excludedOrganizations": [
               {
                    "publisherId": "mon_id",
                    "publisherName": "mon_nom",
                    "organizationClientId": "mon_organisation_1_client_id",
                    "organisationName": "mon_organisation_1_name",
                    "_id": "id_de_l_exclusion",
                    "createdAt": "2025-03-20T15:51:28.320Z", // Date de l'exclusion
                    "updatedAt": "2025-03-20T15:51:28.320Z"
                },
                {
                    "publisherId": "mon_id",
                    "publisherName": "mon_nom",
                    "organizationClientId": "mon_organisation_2_client_id",
                    "organisationName": "mon_organisation_2_name",
                    "_id": "id_de_l_exclusion",
                    "createdAt": "2025-03-20T15:51:28.320Z", // Date de l'exclusion
                    "updatedAt": "2025-03-20T15:51:28.320Z"
                }
        ]
    },
}

Unauthorized

{
    "ok": false,
    "code": "NOT_FOUND",
    "message": "Publisher not found"
}

{
    "ok": false,
    "code": "SERVER_ERROR"
}
PreviousRécupérer la liste de mes partenaires diffuseursNextRécupérer la liste des partenaires diffuseurs pour une organisation

Last updated 2 months ago