API de CAMPILLOPALMERA

Considérations initiales

L'utilisation de cette API est réservée aux programmeurs et aux personnes ayant des connaissances technologiques avancées. Toutes les fonctionnalités que vous souhaitez exécuter via l'API peuvent également être effectuées via l'interface Web. Donc, si vous n'avez pas de connaissances technologiques, essayez d'utiliser l'interface Web.

Identifiant de client et token

Pour pouvoir s'authentifier sur notre API, vous avez besoin de deux données. Veuillez noter que vous ne verrez ces informations que si vous êtes connecté à la page et que ces données sont exclusives de votre compte et ne sont pas personnelles. Ne les partagez avec personne en dehors de votre organisation. Les données qui doivent être incluses dans tous les appels sont:

Vous devez être connecté pour voir ces valeurs. Accès Extranet

Méthodes d'appels aux fonctions

Notre API est au format REST avec l'authentification DIGEST, elle est donc indépendante de la langue qui sera utilisée. Les appels sont toujours effectués sur les suivants endpoints:

Production

https://www.campillopalmera.com/api/v1/(nom de la fonction)/(response_type)

Essais

https://www.campillopalmera.com/api/v1t/(nom de la fonction)/(response_type)

Valeurs d'entrée

Les valeurs d'entrée pour les fonctions seront envoyées au format JSON par requête POST.

Dans certains cas, il est nécessaire une Entidad en tant que paramètre d'entrée pour les méthodes. Pour codifier une Entidad l'information devra être envoyée dans un format de tableau.

Les entités à leur tour peuvent être regroupées Collections, qui ne sont rien de plus que des tableaux des Entités.

Formatos de salida

Nous permettons deux formats de réponse, JSON (valeur par défaut) et XML. L'argument qui doit être spécifié dans les appels est response_type et ses valeurs possibles sont 'json' ou 'xml'.

Valeurs de retour

Toutes les fonctions, en plus des données pouvant être renvoyées en réponse à la demande, renverront également un code d'état HTML que nous pourrons capturer. Il y a un code différent pour chaque situation et ce sont les suivants:

200	La consultation s'est bien passée
201	Les données ont été modifiées correctement
400	Demande incorrecte: un argument a été incorrect
401	Non autorisé, le processus d'authentification a été incorrect
415	Content-type invalide. N'oubliez pas d'utiliser application / json.
500	Une erreur est survenue sur le serveur. Informez-nous pour que nous puissions la réparer.

Demande CURL

curl -H "Content-Type: application/json" -X POST -d '{"data":"value","entity":{"field":"value","another_field":"another_value"},"collection":[{"field":"value","another_field":"another_value"},{"field":"value","another_field":"another_value"}]}' https://www.campillopalmera.com/api/v1t/(nom de la fonction)/(response_type)

Demande PHP + CURL

$url = "https://www.campillopalmera.com/api/v1t/(nom de la fonction)/(response_type)";
$data = '{
    "data": "value",
    "entity": {
        "field": "value",
        "another_field": "another_value"
    },
    "collection": [
        {
            "field": "value",
            "another_field": "another_value"
        },
        {
            "field": "value",
            "another_field": "another_value"
        }
    ]
}';
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_USERPWD, "username:password");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
$response = curl_exec($ch);
$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

Exemple de réponse JSON

{
    "status": 200,
    "result": [
        {
            "codigo": "CODIGO PROVEEDOR",
            "codigo_externo": "CODIGO EXTERNO",
            "razon_social": "RAZON SOCIAL",
            "cif": "CIF",
            "direccion": "DIRECCION",
            "codigo_postal": "CPOSTAL",
            "poblacion": "POBLACION",
            "municipio": "MUNICIPIO",
            "provincia": "PROVINCIA",
            "pais": "ES",
            "notas": "NOTAS"
        },
        {
            "codigo": "CODIGO PROVEEDOR2",
            "codigo_externo": "CODIGO EXTERNO",
            "razon_social": "RAZON SOCIAL",
            "cif": "CIF",
            "direccion": "DIRECCION",
            "codigo_postal": "CPOSTAL",
            "poblacion": "POBLACION",
            "municipio": "MUNICIPIO",
            "provincia": "PROVINCIA",
            "pais": "ES",
            "notas": "NOTAS"
        }
    ],
    "errors": ""
}

Exemple de réponse XML

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>200</status>
  <result>
    <codigo>CODIGO PROVEEDOR</codigo>
    <codigo_externo>CODIGO EXTERNO</codigo_externo>
    <razon_social>RAZON SOCIAL</razon_social>
    <cif>CIF</cif>
    <direccion>DIRECCION</direccion>
    <codigo_postal>CPOSTAL</codigo_postal>
    <poblacion>POBLACION</poblacion>
    <municipio>MUNICIPIO</municipio>
    <provincia>PROVINCIA</provincia>
    <pais>ES</pais>
    <notas>NOTAS</notas>
  </result>
  <result>
    <codigo>CODIGO PROVEEDOR2</codigo>
    <codigo_externo>CODIGO EXTERNO</codigo_externo>
    <razon_social>RAZON SOCIAL</razon_social>
    <cif>CIF</cif>
    <direccion>DIRECCION</direccion>
    <codigo_postal>CPOSTAL</codigo_postal>
    <poblacion>POBLACION</poblacion>
    <municipio>MUNICIPIO</municipio>
    <provincia>PROVINCIA</provincia>
    <pais>ES</pais>
    <notas>NOTAS</notas>
  </result>
  <errors/>
</response>