Présentation
L'API JSON dpae.r3m.fr permet à votre application de transmettre à l'URSSAF vos déclarations d'embauche de manière automatisée et sécurisée.
Les échanges entre votre application et l'API se feront sur le protocole HTTPS avec le format JSON.
Fonctionnement
Voici un déroulé présentant de façon simplifiée le processus mis en œuvre pour déclarer les embauches en utilisant l'API :
- Votre application s'authentifie auprès de l'API et obtient un jeton d'authentification
- Votre application contacte l'API et transmet les données d'une embauche pour laquelle l'employeur doit effectuer une DPAE
- En retour, l'API répond immédiatement avec les erreurs éventuelles ou la bonne prise en compte de la déclaration, et transmet votre déclaration à l'URSSAF de manière sécurisée
Il peut alors s'écouler plusieurs minutes (jusqu'à plusieurs heures), le temps que l'URSSAF traite le dossier de déclaration.
Dès que l'URSSAF a traité le dossier de déclaration, un accusé de réception est transmis de manière sécuriées à l'API. Dès lors :
- L'API lit l'accusé de réception
- L'API déclenche votre webhook et lui fournit les informations nécessaires au traitement de l'accusé de réception par votre application
- Votre application effectue les actions correspondantes au statut de la DPAE (déclarée ou en erreur)
Mode test
Dans un premier temps, votre compte est en mode test.
Les embauches créées en mode test vont tout de même générer des DPAE, mais ces DPAE seront transmises sur une boîte aux lettres technique chez dpae.r3m.fr.
Sur demande, vous pouvez solliciter dpae.r3m.fr pour : - vérifier les données soumises à l'API, - au cas par cas, valider la DPAE, ou créer des cas d'erreurs, - déclencher (ou redéclencher) un webhook
Dès que vous êtes prêt à passer en mode production, prenez contact avec votre responsable dpae.r3m.fr pour désactiver le mode test : à partir de là, vos DPAE seront transmises à l'URSSAF de manière automatisée, et votre webhook sera appelé automatiquement pour chaque DPAE traitée.
Pagination
Pour changer de page, utiliser le paramètre
page
curl -X GET "https://dpae.r3m.fr/api/embauches?page=2" \
-H "Accept: application/json" \
-H "Authorization: Bearer <JWT>"
La pagination est activée par défaut sur toutes les collections.
Le nombre d'enregistrements par page est fixé à 30. Il n'est pas possible de le faire varier, ni de désactiver la pagination.
Authentification
Pour utiliser l'API, vous devez fournir dans les entêtes de chaque requête un jeton JWT (Json Web Token).
Obtenir un jeton
Obtenir un jeton d'authentification
curl -X POST "https://dpae.r3m.fr/api/login_check" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-d "{\"username\": \"johndoe\", \"password\": \"test\"}"
En cas de succès (code 201), un jeton JWT est créé et retourné :
{
"token": "eyJhbGciOiJSUzI1NiJ9.eyJyb2xlcyI6WyJST0xFX1VTRVIiXSwidXNlcm5hbWUiOiJqb2huZG9lIiwiaWF0IjoxNTMwMDUwNTg2LCJleHAiOjE1MzAwNTQxODZ9.ZIN393qlUWcB3YiWzYGKtyuS94jtYxKmkikk25anU9aMPAa7NsMfIHwWNp-hUTRRpNWntC16BOC_2kjsuZ6kAK-32z_iO8T1BBtpPviTTs01kkkInUoaOfWtD3zK-x-RYMAOsTYq4kZQcIIaT0A-Gr0lSrZDK25NC5uJ6BWSy1qKw5jMZ5jbdAkFacg2XFjHM5dJG5US9jqDdhgu7QheeTdupVkEByHgcQ37bYX2lO4ouFtHovIYV7SdkEwrCE6pZm3uaEHKIN5BpBc6JLBQva6nGundOhQDK19ZCz5tM_IgIejFK015HjSW75AON25_NExREl2kEP-wJYfZ6VJ54WPx0y8oh_Tn0IO1XQv-xKBaYzNv2LOemKOVDZwFPU6PMVZbCZBf-sh0SkCUkGiQGf8IeX1CSHghMFz2d4wElewFlSVhxzfZIkAZHx3EAjcnfZZSgA3dKmzq4SZv1Vrdu36o3X8i7jUmCKSE2wjO-tKck4fysYqKGKqpcjAMYnRkPstjnj2YzW7w42ditoeQsGj_bMunWAjb8PPLIh00yMguHv3g1G5nPkg-CwIbbyt1ayuNyWTxONUR_TZoIdFuTkzKMW0Zf0ni08MrMaRz8eSMGYIlSU8SZm8-wVug5Duw4VkBSKWA9F4N1JiXALerVY1T5CAWGeQgpkvh4UNIXh0"
}
Utilisez les identifiants fournis lors de l'inscription au service pour obtenir un jeton d'authentification.
Quota
L'authentification est soumise à un quota de 5 appels par minute. Nous vous conseillons donc fortement de ne pas inclure l'authentification à chaque appel à l'API.
Au lieu de ça, préférez obtenir un jeton et le stocker de manière sécurisée, pour le réutiliser sur plusieurs appels à l'API. Et, de manière périodique, ou lorsque l'API renvoie une erreur 401, vous pouvez renouveler le jeton avec un nouvel appel à l'API d'authentification.
Conserver le jeton JWT
Le jeton permet à votre application d'utiliser l'API, et d'être reconnue comme utilisatrice de votre compte sur l'API.
Si vous avez plusieurs environnements (dev, test, prod) qui nécessitent un accès à l'API, nous vous conseillons de créer plusieurs jetons : un par environnement.
Autoriser les requêtes
Exemple d'autorisation d'une requête listant les embauches (remplacez
<JWT>
par le jeton JWT)
curl -X GET "https://dpae.r3m.fr/api/embauches" \
-H "accept: application/json" \
-H "Authorization: Bearer <JWT>"
Le jeton JWT doit être passé dans l'entête http Authorization
, préfixé par la valeur Bearer
(veillez à bien laisser un espace entre Bearer
et le token).
Embauches
Liste des embauches
curl -X GET "https://dpae.r3m.fr/api/embauches" \
-H "Accept: application/json" \
-H "Authorization: Bearer <JWT>"
La commande retourne un JSON représentant une embauche et sa DPAE
[
{
"id": "5ff7f313-3770-4ba0-a95b-60e3254f74ae",
"dpae": {
"id": "7af39bf6-e4ac-41cb-ba90-180321a76d9c",
"statutTraitement": 0,
"statutTraitementDescription": "La DPAE est prête à être transmise à l'URSSAF.",
"refDossier": "",
"codeRetourAr": "",
"dateEnregistrement": null,
"createdAt": "2019-08-30T21:57:30+00:00",
"updatedAt": "2019-08-30T22:01:01+00:00"
},
"idExterne": "abcd",
"raisonSociale": "R3M EVENEMENT",
"siret": "67846960300074",
"nomAbonneUrssaf": "DUPUIS",
"prenomAbonneUrssaf": "PATRICK",
"codeUrssaf": "460",
"adresse1": "RUE DES ARTS",
"adresse2": "BP 13011",
"codePostal": "19000",
"ville": "ARTVILLE",
"telephone": "",
"codeNaf": "9001Z",
"codeCentreMedecineTravail": "MT348",
"salarieNom": "DOE",
"salarieNomEpoux": "",
"salariePrenom": "JOHN",
"salarieNumeroSecu": "1900318049025",
"salarieSexe": "F",
"salarieDateNaissance": "18031990",
"salarieLieuNaissance": "BIENLOIN",
"salarieDepartementNaissance": "98",
"dateEmbauche": "16082018",
"heureEmbauche": "1400",
"typeContrat": "1",
"dateFinCDD": "16082018",
"dureePeriodeEssai": "",
"createdAt": "2019-08-30T21:57:30+00:00",
"updatedAt": "2019-08-30T22:01:01+00:00"
}
]
Obtenir la liste de vos déclarations d'embauche
Requête HTTP
GET https://dpae.r3m.fr/api/embauches
Paramètres de la requête
Propriété | Type |
---|---|
idExterne | Exact |
siret | Exact |
Réponse
Une liste d'entité Embauche
.
Soumettre une embauche
Soumettre une nouvelle embauche (données simplifiées)
curl -X POST "https://dpae.r3m.fr/api/embauches" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <JWT>" \
-d "{\"salarieNom\": \"John Doe\"}"
{
"id": "5ff7f313-3770-4ba0-a95b-60e3254f74ae",
"dpae": {
"id": "7af39bf6-e4ac-41cb-ba90-180321a76d9c",
"statutTraitement": 0,
"refDossier": "",
"codeRetourAr": "",
"dateEnregistrement": null,
"statutTraitementDescription": "La DPAE est prête à être transmise à l'URSSAF.",
"createdAt": "2019-08-30T21:57:30+00:00",
"updatedAt": "2019-08-30T22:01:01+00:00"
},
"idExterne": "abcd",
"raisonSociale": "R3M EVENEMENT",
"siret": "67846960300074",
"nomAbonneUrssaf": "DUPUIS",
"prenomAbonneUrssaf": "PATRICK",
"codeUrssaf": "460",
"adresse1": "RUE DES ARTS",
"adresse2": "BP 13011",
"codePostal": "19000",
"ville": "ARTVILLE",
"telephone": "",
"codeNaf": "9001Z",
"codeCentreMedecineTravail": "MT348",
"salarieNom": "DOE",
"salarieNomEpoux": "",
"salariePrenom": "JOHN",
"salarieNumeroSecu": "1900318049025",
"salarieSexe": "F",
"salarieDateNaissance": "18031990",
"salarieLieuNaissance": "BIENLOIN",
"salarieDepartementNaissance": "98",
"dateEmbauche": "16082018",
"heureEmbauche": "1400",
"typeContrat": "1",
"dateFinCDD": "16082018",
"dureePeriodeEssai": "",
"createdAt": "2019-08-30T21:57:30+00:00",
"updatedAt": "2019-08-30T22:01:01+00:00"
}
Exemple de réponse avec une erreur (statut HTTP 400)
{
"type": "https://tools.ietf.org/html/rfc2616#section-10",
"title": "An error occurred",
"detail": "salarieNom: This value should not be blank.",
"violations": [
{
"propertyPath": "salarieNom",
"message": "This value should not be blank."
}
]
}
Créer une déclaration d'embauche
Afin de créer une déclaration d'embauche, votre application doit transmettre à l'API les données de l'employeur, du salarié, et de l'embauche.
Requête HTTP
POST https://dpae.r3m.fr/api/embauches
Corps de la requête
Propriété | Description | Type | Obligatoire |
---|---|---|---|
idExterne | ID dans votre application | alpha |
Non |
raisonSociale | Raison sociale de l'établissement | alphaNumPlus , max. 64 caractères |
Oui |
siret | Numéro de SIRET de l'établissement | numeric , 14 chiffres |
Oui |
nomAbonneUrssaf | Nom de l'abonné aux services en ligne de l'URSSAF | alphaPlus , max. 32 caractères |
Oui |
prenomAbonneUrssaf | Prénom de l'abonné aux services en ligne de l'URSSAF | alphaPlus , max. 32 caractères |
Oui |
codeUrssaf | Code de l'URSSAF réceptrice des données. Liste des Codes URSSAF : https://www2.due.urssaf.fr/declarant/jasperServlet | numeric , 3 chiffres |
Oui |
adresse1 | Adresse de l'établissement (1ere ligne) | alphaNumPlusPlus , max. 32 caractères |
Oui |
adresse2 | Adresse de l'établissement (2e ligne) | alphaNumPlusPlus , max. 32 caractères |
Non |
codePostal | Code postal de l'établissement | numeric , max. 5 chiffres |
Oui |
ville | Code postal de l'établissement | alphaNumPlusPlus , max. 27 caractères |
Oui |
telephone | Numéro de téléphone de l'employeur | numeric , max. 11 chiffres |
Non |
codeNaf | Code NAF de l'employeur (nouvelle nomenclature 2008) | alphaNum , 5 caractères |
Oui |
codeCentreMedecineTravail | Code centre de médecine du travail. Liste des Codes Service santé (Code SST) : https://www2.due.urssaf.fr/declarant/jasperServlet. Si le centre de médecine est interne à l'établissement, renseignez "MT999". | alphaNum , 5 caractères |
Oui (sauf si contrat CTT) |
salarieNom | Nom du salarié | alphaPlus , max. 32 caractères |
Oui |
salarieNomEpoux | Nom d'époux du salarié | alphaPlus , max. 32 caractères |
Non |
salariePrenom | Prénom du salarié | alphaPlus , max. 32 caractères |
Oui |
salarieNumeroSecu | Numéro de sécurité sociale. Ne pas passer la clé de contrôle. Pour la Corse, 2A ou 2B est accepté. | alphaNum , 13 caractères |
Non |
salarieSexe | Sexe du salarié (M/F) | alpha , 1 caractère : M ou F |
Oui |
salarieDateNaissance | Date de naissance (format JJMMAAAA) | numeric , 8 chiffres |
Oui |
salarieLieuNaissance | Lieu de naissance du salarié (commune ou pays) | alphaNumPlusPlus , max. 24 caractères |
Oui |
salarieDepartementNaissance | Code du département de naissance du salarié. Si né hors de France, renseignez 99. Si né dans un DROM/COM, renseignez les deux premiers chiffres du numéro du DROM/COM (soit 97 ou 98). | alphaNum , 2 caractères |
Oui |
dateEmbauche | Date de l'embauche (format JJMMAAAA) | numeric , 8 chiffres |
Oui |
heureEmbauche | Heure de l'embauche (format HHMM) | numeric , 4 chiffres |
Oui |
typeContrat | Code type de contrat (1, 2, 3) pour CDD, CDI, CTT | numeric , 1 chiffre |
Oui |
dateFinCDD | Date de fin de CDD (format JJMMAAAA) | numeric , 8 chiffres |
Non (sauf si typeContrat=1) |
dureePeriodeEssai | Durée de la période d'essai, en jours | numeric , max. 3 chiffres |
Non |
Description des types de données
Il est primordial que les données envoyées à l'api respectent le format et la casse imposés. Cela vous garantira que l'URSSAF puisse traiter correctement la DPAE, et réduira par conséquent le taux de refus.
Type | Format |
---|---|
alpha | [A-Z] |
alphaPlus | [-A-Z &.] |
alphaNum | [A-Z0-9] |
alphaNumPlus | [-A-Z0-9 &] |
alphaNumPlusPlus | [-A-Z0-9 &.,'] |
numeric | [0-9] |
Réponse
L'entité Embauche
créée.
Détail d'une embauche
curl -X GET "https://dpae.r3m.fr/api/embauches/7fb63477-c874-4d0c-8660-a728e980bfc6" \
-H "Accept: application/json" \
-H "Authorization: Bearer <JWT>"
{
"id": "5ff7f313-3770-4ba0-a95b-60e3254f74ae",
"dpae": {
"id": "7af39bf6-e4ac-41cb-ba90-180321a76d9c",
"statutTraitement": 0,
"refDossier": "",
"codeRetourAr": "",
"dateEnregistrement": null,
"statutTraitementDescription": "La DPAE est prête à être transmise à l'URSSAF.",
"createdAt": "2019-08-30T21:57:30+00:00",
"updatedAt": "2019-08-30T22:01:01+00:00"
},
"idExterne": "abcd",
"raisonSociale": "R3M EVENEMENT",
"siret": "67846960300074",
"codeUrssaf": "460",
"adresse1": "RUE DES ARTS",
"adresse2": "BP 13011",
"codePostal": "19000",
"ville": "ARTVILLE",
"telephone": "",
"codeNaf": "9001Z",
"codeCentreMedecineTravail": "MT348",
"salarieNom": "DOE",
"salarieNomEpoux": "",
"salariePrenom": "JOHN",
"salarieNumeroSecu": "1900318049025",
"salarieSexe": "F",
"salarieDateNaissance": "18031990",
"salarieLieuNaissance": "BIENLOIN",
"salarieDepartementNaissance": "98",
"dateEmbauche": "16082018",
"heureEmbauche": "1400",
"typeContrat": "1",
"dateFinCDD": "16082018",
"dureePeriodeEssai": "",
"createdAt": "2019-08-30T21:57:30+00:00",
"updatedAt": "2019-08-30T22:01:01+00:00"
}
Obtenir les informations sur une déclaration d'embauche
Requête HTTP
GET https://dpae.r3m.fr/api/embauches/{id}
Paramètres
Paramètre | Description | Obligatoire |
---|---|---|
{id} | Identifiant de l'embauche | Oui |
Réponse
Une entité Embauche
est retournée.
L'entité Embauche
contient l'ensemble des données fournies à l'API lors de son enregistrement, avec notamment :
- un id
unique à la base de donnée dpae.r3m.fr
- un objet dpae
représentant la DPAE et son statut de traitement
- createdAt
et updatedAt
qui représentent respectivement la date de création et la date de dernière mise à jour de l'entité, au format ISO 8601
Propriété | Description |
---|---|
dpae.id | Identifiant technique de la DPAE dans la base de donnée dpae.r3m.fr |
dpae.statutTraitement | Code statut du traitement de la DPAE dans la base de donnée dpae.r3m.fr : 0 (la DPAE est prête à être transmise à l'URSSAF), 1 (la DPAE a été transmise à l'URSSAF; attente de l'accusé de réception), 2 (l'URSSAF a accusé réception de la DPAE). |
dpae.refDossier | Réference de dossier fourni par l'URSSAF lors de l'enregistrement de la DPAE |
dpae.codeRetourAr | Code retour fourni par l'URSSAF lors de l'enregistrement de la DPAE. La liste des codes retour est décrite plus bas dans la documentation |
dpae.dateEnregistrement | Date de l'enregistrement de la DPAE dans la base URSSAF. Format |
dpae.statutTraitementDescription | Description de statutTraitement |
dpae.createdAt | Date de création de l'entité au format ISO 8601 |
dpae.updatedAt | Date de dernière mise à jour de l'entité au format ISO 8601 |
Webhooks
Il est possible d'être notifié par l'API dès qu'un accusé de réception est disponible. Il suffit de déclarer une URL de votre application en tant que webhook. Ainsi, il ne sera pas nécessaire d'interroger régulièrement l'API pour connaître le statut de vos déclarations d'embauche : c'est l'API qui notifiera votre application, en lui passant toutes les informations nécessaires au traitement de l'accusé de réception.
Lorsque qu'une DPAE est traitée par l'URSSAF, et si vous avez enregistré et activé un webhook sur votre compte, ce webhook sera appelé par l'API DPAE.
Une requête POST
sur l'URL du webhook est effectuée, et contient un objet JSON représentant l'embauche (le même que celui retourné lors d'un appel à /api/embauches/{id}
).
Entêtes HTTP
Entête HTTP de la requête
User-Agent: Dpae-Webhook/1.0
X-Dpae-Webhook-Id: 2050b3f0-64f7-4996-95a7-4853d7349471
X-Dpae-Webhook-Action: embauche.declaree
Un user-agent et des entêtes HTTP spécifiques sont ajoutés à la requête. Cela peut vous permettre d'appliquer certaines règles de gestion ou de sécurité sur votre système.
Exemple d'en-tête de signature de la requête
X-Dpae-Signature: sha1=5d43cdd689735b008b3c702edd92eea23791a3e1
Afin d'être sûr que la requête faite sur votre URL provient bien de API DPAE, et n'a pas été forgée ou altérée par un tiers, nous vous conseillons d'utiliser une clé secrête.
Si vous avez renseigné la propriété secret
sur votre webhook, l'entête X-Dpae-Signature
sera ajouté.
La signature de la requête est faite de cette façon : sha1(corps de la requête + secret)
.
Liste des webhooks
curl -X GET "https://dpae.r3m.fr/api/webhooks" \
-H "Accept: application/json" \
-H "Authorization: Bearer <JWT>"
Retourne la liste des webhooks
[
{
"id": "2050b3f0-64f7-4996-95a7-4853d7349471",
"enabled": true,
"endpoint": "https://mon.appli.fr/api/dpae_callback",
"action": "embauche.declaree",
"secret": "7ab657d689735b00eea23791a3e18b3c702edd92",
"createdAt": "2019-08-30T21:57:30+00:00",
"updatedAt": "2019-08-30T22:01:01+00:00"
}
]
Requête HTTP
GET https://dpae.r3m.fr/api/webhooks
Réponse
Une liste d'entité Webhook
Créer un webhook
curl -X POST "https://dpae.r3m.fr/api/webhooks" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <JWT>" \
-d "{ \"enabled\": true, \"endpoint\": \"https://mon.appli.fr/api/dpae_callback\", \"action\": \"embauche.declaree\", \"secret\": \"7ab657d689735b00eea23791a3e18b3c702edd92\"}"
Exemple de réponse (statut http 201)
{
"id": "2050b3f0-64f7-4996-95a7-4853d7349471",
"enabled": true,
"endpoint": "https://mon.appli.fr/api/dpae_callback",
"action": "embauche.declaree",
"secret": "7ab657d689735b00eea23791a3e18b3c702edd92",
"createdAt": "2019-08-30T21:57:30+00:00",
"updatedAt": "2019-08-30T22:01:01+00:00"
}
Exemple de réponse avec une erreur (statut http 400)
{
"type": "https://tools.ietf.org/html/rfc2616#section-10",
"title": "An error occurred",
"detail": "endpoint: This value should not be blank.",
"violations": [
{
"propertyPath": "endpoint",
"message": "This value should not be blank."
}
]
}
Requête HTTP
POST https://dpae.r3m.fr/api/webhooks
Corps de la requête
Propriété | Description | Type | Obligatoire |
---|---|---|---|
endpoint | URL de votre application qui sera appelée | Alpha | Oui |
enabled | Etat actif/inactif du webhook. Un webhook inactif ne sera pas déclenché. | Booléen | Oui |
action | Nom de l'action qui déclenchera le webhook. Valeur admise : embauche.declaree . |
Alpha | Oui |
secret | Clé de salage utilisée pour signer le contenu de la requête. Cela permet de sécuriser et d'authentifier les appels à l'URL de votre application. La signature de la requête est faite de cette façon : sha1(contenu de la requête + secret) . La signature est ensuite incluse dans l'en-tête X-Dpae-Signature de la requête HTTP. Ex. : X-Dpae-Signature: sha1=5d43cdd689735b008b3c702edd92eea23791a3e1 . |
Alpha | Oui |
Actions disponibles
Action | Description | Contenu |
---|---|---|
embauche.declaree |
Cette action est déclenchée lors qu'une embauche a été déclarée auprès de l'URSSAF. Lors du déclenchement de cette action, votre application peut considérer que le processus de déclaration préalable à l'embauche (DPAE) est terminé. | Une entité Embauche . |
Réponse
L'entité Webhook
créée.
Détail d'un webhook
Exemple d'appel
curl -X GET "https://dpae.r3m.fr/api/webhooks/2050b3f0-64f7-4996-95a7-4853d7349471" \
-H "Accept: application/json" \
-H "Authorization: Bearer <JWT>"
Exemple de réponse (statut HTTP 200)
{
"id": "2050b3f0-64f7-4996-95a7-4853d7349471",
"enabled": true,
"endpoint": "https://mon.appli.fr/api/dpae_callback",
"action": "embauche.declaree",
"secret": "7ab657d689735b00eea23791a3e18b3c702edd92",
"createdAt": "2019-08-30T21:57:30+00:00",
"updatedAt": "2019-08-30T22:01:01+00:00"
}
Requête HTTP
GET https://dpae.r3m.fr/api/webhooks/{id}
Paramètres de la requête
Paramètre | Description | Obligatoire |
---|---|---|
{id} | Identifiant du webhook | Oui |
Réponse
L'entité Webhook
demandée.
Modifier un webhook
curl -X PUT "https://dpae.r3m.fr/api/webhooks/2050b3f0-64f7-4996-95a7-4853d7349471" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <JWT>" \
-d "{\"enabled\": false}"
Exemple de réponse (statut HTTP 200)
json { "id": "2050b3f0-64f7-4996-95a7-4853d7349471", "enabled": false, "endpoint": "https://mon.appli.fr/api/dpae_callback", "action": "embauche.declaree", "secret": "7ab657d689735b00eea23791a3e18b3c702edd92", "createdAt": "2019-08-30T21:57:30+00:00", "updatedAt": "2019-08-30T22:01:01+00:00" }
Modifier un webhook existant.
Requête HTTP
PUT https://dpae.r3m.fr/api/webhooks/{id}
Paramètres de la requête
Paramètre | Description | Obligatoire |
---|---|---|
{id} | Identifiant du webhook | Oui |
Corps de la requête
Se référer à la documentation pour créer un webhook.
Réponse
L'entité Webhook
modifiée.
Supprimer un webhook
Exemple d'appel en utilisant cURL
curl -X DELETE "https://dpae.r3m.fr/api/webhooks/2050b3f0-64f7-4996-95a7-4853d7349471" \
-H "Accept: application/json" \
-H "Authorization: Bearer <JWT>"
Requête HTTP
DELETE https://dpae.r3m.fr/api/webhooks/{id}
Paramètres de la requête
Paramètre | Description | Obligatoire |
---|---|---|
{id} | Identifiant du webhook | Oui |
Réponse
Cette méthode ne renvoie aucune réponse.
Annexes
Codes retours URSSAF
Cette liste vous permettra de comprendre les codes retours que l'URSSAF transmet dans l'accusé réception de la DPAE.
Pour les autres, après correction des données dans votre application, il faudra créer une nouvelle embauche à l'aide de l'API, qui transmettra une nouvelle DPAE à l'URSSAF.
Code | Description |
---|---|
00 | Correct |
01 | SIRET invalide - syntaxiquement incorrect |
02 | Code URSSAF invalide - n'appartenant pas à la liste des Codes Urssaf |
03 | Code APE invalide - n'appartenant pas à la liste des codes APE(NAF) |
05 | Nom ou raison sociale invalide – non renseignée ou caractères interdits |
06 | Adresse invalide - non renseignée |
07 | Code postal invalide - ne comportant pas 5 caractères numériques |
08 | Commune invalide - non renseignée |
11 | Code origine application incorrect |
12 | Code origine saisie invalide - non renseigné |
31 | Nom salarié invalide - non renseigné |
32 | Prénom salarié invalide - non renseigné |
33 | Date de naissance salarié invalide - invraisemblable ou non renseignée |
34 | Lieu de naissance invalide - non renseigné |
35 | Date et/ou Heure d'embauche invalide - invraisemblable ou non renseignée |
38 | Numéro de sécurité sociale invalide - invraisemblable, département inexistant,... |
39 | Date de déclaration invalide - invraisemblable ou non renseignée |
40 | Heure de déclaration invalide - invraisemblable ou non renseignée |
43 | Sexe du salarié Invalide -différent de M ou F - non renseigné |
44 | Type de contrat Invalide – différent de 1,2 ou 3 - non renseigné |
45 | Code NAF invalide pour le type de contrat CTT |
46 | Date de fin de CDD obligatoire pour un contrat CDD ou invalide (par ex. antérieure à la date d'embauche) |
47 | Département de naissance invalide - non renseigné |
50 | Code médecine du travail invalide - non renseigné |
98 | DPAE déjà existante (nom, prénom, date naissance, heure & date embauche et siret) |
99 | Autre erreur (erreur concernant des données facultatives) |
Codes centre de médecine du travail
La liste des Codes Service santé (Code SST) ou code centre de médecine du travail est disponible à cette adresse : https://www2.due.urssaf.fr/declarant/jasperServlet
Le code du service santé (médecine du travail) du siège social du déclarant devra être passé lors de la déclaration d'embauche dans la propriété codeCentreMedecineTravail
.
Si le centre de médecine est interne à l'établissement, vous devrez renseigner MT999
.
Historique
Date | Description |
---|---|
2020-03-23 | [FIX] Permettre de renseigner un numéro de sécu Corse avec 2A ou 2B comme numéro de département |
2020-03-23 | [DOC] Précision sur le numéro de département d'un salarié né dans un DROM/COM |
2019-10-13 | [DOC] Ajout de la signification des codes Dpae.statutTraitement |
[FIX] Correction du 's' manquant dans les endpoints /api/webhooks | |
2019-08-31 | [DOC] Ajout des createdAt/updatedAt sur les entités Embauche, Dpae, Webhook |
2018-12-06 | [DOC] Ajout de la description des propriétés d'une Embauche et des formats attendus. |
2018-09-28 | [DOC] Ajout d'un paragraphe sur le fonctionnement des webhook |
[DOC] Ajout de précisions sur le mode test |