Espace développeurs

Pour favoriser le développement d'innovations et pour mettre à disposition le plus largement possible les informations liées aux services en ligne proposés par les administrations calédoniennes, service-public.nc ouvre ses données et les rend accessibles via une API (interface de programmation applicative). 

Ce service est actuellement en expérimentation et en recherche d'amélioration continue. N'hésitez pas à fournir vos feedbacks pour nous aider à nous améliorer.

Les API proposées permettent de disposer du contenu à jour provenant de service-Public.nc. Ce contenu est limité aux pages hébergées par service-public.nc. Il n’inclut donc pas le contenu des sites partenaires.

Les API Service-Public.nc sont accessible via HTTPS et retournent les données selon la spécification JSON API.

Support / Service en version bêta

Les API Service-public.nc sont en version bêta et peuvent être sujettes à changements et améliorations.

Veuillez à ce que votre application puisse supporter des périodes d’indisponibilité. Si vous souhaitez être informés des mises à jour, dites-le nous :)

Si vous rencontrez des difficultés ou si vous avez des questions concernant les API Service-public.nc, veuillez nous contacter.

Demander l’accès aux API

Pour obtenir vos identifiants d’accès aux API Service-Public.nc, renseignez les éléments suivants et envovez-les à contact@service-public.nc 

  1. Nom de la structure
  2. Description brève du service et de l’utilisation prévue
  3. Nom et email du responsable de traitement (facultatif si la demande concerne un POC)
  4. Nom et email du responsable technique (cette personne recevra les accès techniques, il peut s’agir d’un prestataire)
  5. Indiquez que vous accepter les conditions d'utilisation définies dans la page https://service-public.nc/espace-developpeurs
Utiliser les API

Pré-requis

Pour réutiliser le contenu de Service-public.nc par les API, vous devez au préalable obtenir vos identifiants et accepter les conditions générales d’utilisation (cf étape précédente).

Un login/mot de passe vous sera délivré. Veillez à protéger ces informations en suivant ces bonnes pratiques :

  • Ne faites pas figurer vos identifiants en clair dans le code source de votre application mais enregistrez-les dans des variables d'environnement ou dans des fichiers dédiés protégés ;
  • Retirez ceux devenus inutiles et informez-nous afin qu’ils soient supprimés ;
  • Lorsque vous publiez du code sur une plateforme de gestion de versions, assurez-vous que vos identifiants n'apparaissent pas.

Etape 1 - Générer un access token

Les ressources proposées nécessitent un token d’authentification (access_token) valide. Pour l’obtenir il suffit d’appeler la ressource /login-token avec vos identifiants.

Exemple d’appel :

$ curl –u "USER:PASSWORD" https://service-public.nc/api/login-token

Exemple de retour :

{
    "access_token": "N0c2F384Jn3j52Y5MPgK1cRm9o9VTxNWMgaM6J_4_7A",
    "type": "Bearer",
    "expires_in": 86400,
    "refresh_token": "kIgfgtIPfKaXrMmMtSzguQ6VXgaY-yQcnbuFqLT1zyQ"
}

Etape 2 - Requêter une API

L’API service-public.nc fournit plusieurs ressources :

Ressources Description

/dossiers

Afficher les dossiers de SPNC

/faqs

Afficher les « comment faire si »

/teleservices

Afficher les formulaires et services en ligne

/contacts

Afficher l’annuaire des administrations

 

L'URL permettant de requêter une API est constituée des éléments suivants :

  1. le point d'accès https://service-public.nc/api
  2. la version de l’API (1.0 par défaut)
  3. le nom de la ressource
  4. l’access token
  5. les paramètres spécifiques à l'API manipulée

Exemple d’appel de la ressource "dossier" :

Exemple de retour :

{
    "access_token": "N0c2F384Jn3j52Y6MPgK1cRm9o9VTxNWMgaM6J_4_7A",
    "type": "Bearer",
    "expires_in": 86400,
    "refresh_token": "kIgfgtIPfKaXrMmMtSzguQ7VXgaY-yQcnbuFqLT1zyQ"
}

Cas d'erreurs possibles

Access token erroné ou absent :

{
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title": "Bad credentials. Anonymous user resolved for a resource that requires authentication.",
    "status": 401,
    "detail": "Unauthorized"
}
Conditions d’utilisation

L'utilisation d'une API Service-public.nc nécessite de préciser les informations suivantes dans votre application :

  • l’absence de responsabilité de Service-public.nc dans l’utilisation qui est faite de ces données dans l’application ;
  • la référence aux autorisations CNIL auxquelles vous devez éventuellement vous soumettre en tant que développeur ;
  • les données et services qui seront utilisés par l’application.

Par ailleurs, veillez à ne pas :

  • utiliser le terme Service-public.nc d’une manière qui suggère un partenariat, un parrainage ou une approbation de notre part ;
  • combiner Service-public.nc avec votre nom, vos marques ou des termes génériques ;
  • utiliser des noms ou des logos qui imitent ou pourraient être confondus avec Service-public.nc ;
  • présenter les éléments Service-public.nc comme les fonctionnalités les plus caractéristiques ou les plus remarquables de votre application.

Si vous souhaitez utiliser le logo Service-public.nc, veuillez nous contacter.

Lors du développement et de l’exploitation de votre application, prêtez attention à ce que :

  • le volume des données consommées par votre application reste raisonnable. Service-public.nc mettra en œuvre les moyens nécessaires pour que ses API puissent répondre à l’ensemble des sollicitations ;
  • l’application soit suffisamment sécurisée pour supporter des indisponibilités temporaires d'une API même si nous mettons tout en œuvre pour que cela n’arrive pas ;
  • l’application ne puisse pas être détournée par des tiers.