loader Wird geladen ...
Aceptar Cookies

Esta web utiliza Cookies para obtener datos estadísticos de la navegación de sus usuarios. Puede obtener más información, o bien conocer cómo cambiar la configuración, en nuestra Cookie-Richtlinien.

API de CAMPILLOPALMERA

Erste Überlegungen

Die Verwendung dieser API ist auf Programmierer und Personen mit fortgeschrittenen technologischen Kenntnissen beschränkt. Alle Funktionen, die Sie über die API ausführen möchten, können auch über die Webschnittstelle ausgeführt werden. Wenn Sie also keine technischen Kenntnisse haben, versuchen Sie, die Webschnittstelle zu verwenden.

Kundenerkennung und Token

Um sich gegen unsere API authentifizieren zu können, benötigen Sie zwei Daten. Beachten Sie, dass diese Informationen nur dann angezeigt werden, wenn Sie bei der Seite angemeldet sind und diese Daten für Ihr Konto eindeutig und nicht personenbezogen sind. Teilen Sie niemanden außerhalb Ihrer Organisation mit. Die Daten, die in allen Aufrufen enthalten sein sollten, sind:


Um dies Werte sehen zu können müssen Sie angemeldet sein. Zugang Extranet


Methoden zur Funktionsaufrufe

Unsere API hat das REST-Format mit DIGEST-Authentifizierung und ist daher unabhängig von der verwendeten Sprache. Anrufe werden immer zu folgenden Zwecken getätigt endpoints:

Produktion

https://www.campillopalmera.com/api/v1/(funktionsname)/(response_type)

Proben

https://www.campillopalmera.com/api/v1t/(funktionsname)/(response_type)

Eingabewerte

Die Eingabewerte für die Funktionen werden im JSON-Format per POST-Anfrage gesendet.

In einigen Fällen benötigt man eine Entidad als Eingabeparameter für die Methoden, um zu kodieren Entidad die Informationen sollten in einem Array-Format gesendet werden.

Die Entitäten können wiederum gruppiert werden in Sammlungen, das sind nichts weiter als Arrays von Entitäten.


Formatos de salida

Wir erlauben zwei Antwortformate, JSON (Standardwert) und XML. Das Argument, das in den Anrufen angegeben werden muss, ist response_type und seine möglichen Werte sind 'json' oder 'xml'.


Rückgabewerte

Alle Funktionen geben zusätzlich zu den Daten, die als Antwort auf die Anforderung zurückgegeben werden können, auch einen HTML-Statuscode zurück, den wir erfassen können. Für jede Situation gibt es einen anderen Code und es sind die folgenden:

200 Die Konsultation ist gut verlaufen
201 Die Daten wurden korrekt geändert
400 Falsche Anfrage: Einige Argumente sind falsch
401 Nicht autorisiert, der Authentifizierungsprozess ist falsch
415 Content-Typ ist ungültig. Denken Sie daran, die Anwendung / json anzuwenden.
500 Auf dem Server ist ein Fehler aufgetreten. Informieren Sie uns, um es zu beheben.

Curl beantragen

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/(funktionsname)/(response_type)

PHP + CURL beantragen

$url = "https://www.campillopalmera.com/api/v1t/(funktionsname)/(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);

Beispiel einer Antwort 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": ""
}

Beispiel XML-Antwort

<?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>