KelkunDéveloppeurs

Lire une demande

La demande telle que l'entreprise a le droit de la voir, avant et après positionnement.

Même format que le webhook. La lecture sert aussi à suivre une demande : places restantes (seats_left) et statut (status).

curl "https://api.kelkun.app/partner/constructions/<id de la demande>?organization_id=<organization_id>" \
  -H "x-api-key: <votre clé>"

Ce que voit l'entreprise

Avant positionnement, la demande montre ce que montre le webhook. Après, elle ajoute les coordonnées du client.

ChampAvant positionnementAprès
customer.first_namevisiblevisible
customer.last_nameinitiale (« D. »)nom complet
customer.phone, customer.emailnullvisibles
addressnullrue, code postal et ville du chantier
access_informationnullcode, étage, consignes d'accès
locationarrondieexacte, is_location_exact à true

Un champ peut valoir null même après positionnement quand le client ne l'a pas renseigné. La description est toujours débarrassée de la rue, du téléphone et de l'e-mail que le client aurait pu y écrire.

Référence

GET
/partner/constructions/{id}
x-api-key<token>

La clé d'API que Kelkun vous a transmise.

Dans: header

Paramètres de chemin

id*string

Identifiant de la demande, reçu dans le webhook.

Formatuuid

Paramètres de requête

organization_id*string

Identifiant Kelkun de l'entreprise pour laquelle vous agissez. Elle doit être rattachée à votre compte partenaire.

Formatuuid

Corps de la réponse

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/partner/constructions/497f6eca-6276-4993-bfeb-53cbbbba6f08?organization_id=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "reference": "K7Q2M",  "title": "Recherche de fuite sous dalle",  "description": "string",  "status": "PUBLISHED",  "skills": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "Recherche de fuite"    }  ],  "city": {    "name": "Agen",    "zip": "47000",    "department": "Lot-et-Garonne"  },  "location": {    "latitude": 44.2,    "longitude": 0.62  },  "is_location_exact": true,  "desired_delay_months": 0,  "quotes_requested": 3,  "positioned_count": 0,  "seats_left": 3,  "price_credits": 5,  "published_at": "2019-08-24T14:15:22Z",  "photos": [    {      "url": "string",      "thumbnail_url": "string",      "mime_type": "image/jpeg"    }  ],  "is_positioned": true,  "customer": {    "first_name": "Marie",    "last_name": "D.",    "phone": "string",    "email": "string"  },  "address": {    "street": "string",    "zip": "string",    "city": "string"  },  "access_information": "string"}

Sur cette page