Contexto GET

Devuelve el cliente y los contribuyentes habilitados para tu API Key. Es el punto de partida para conocer que RUC y servicios puedes operar.

GET /v1/contexto
curl -s "https://staging-api.mynexusapi.com/v1/contexto" \
  -H "X-Api-Key: $ECUAFACT_API_KEY"
using var http = new HttpClient();
http.DefaultRequestHeaders.Add("X-Api-Key", apiKey);

string json = await http.GetStringAsync("https://staging-api.mynexusapi.com/v1/contexto");
Console.WriteLine(json);
import os, requests

r = requests.get(
    "https://staging-api.mynexusapi.com/v1/contexto",
    headers={"X-Api-Key": os.environ["ECUAFACT_API_KEY"]},
    timeout=30)
print(r.status_code, r.text)
const res = await fetch('https://staging-api.mynexusapi.com/v1/contexto', {
  headers: { 'X-Api-Key': process.env.ECUAFACT_API_KEY }
});
console.log(res.status, await res.text());
<?php
$ch = curl_init('https://staging-api.mynexusapi.com/v1/contexto');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['X-Api-Key: ' . getenv('ECUAFACT_API_KEY')],
]);
$respuesta = curl_exec($ch);
$estado = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $estado . ' ' . $respuesta;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient cliente = HttpClient.newHttpClient();
HttpRequest peticion = HttpRequest.newBuilder()
    .uri(URI.create("https://staging-api.mynexusapi.com/v1/contexto"))
    .header("X-Api-Key", System.getenv("ECUAFACT_API_KEY"))
    .GET()
    .build();
HttpResponse<String> respuesta = cliente.send(peticion, HttpResponse.BodyHandlers.ofString());
System.out.println(respuesta.statusCode() + " " + respuesta.body());
using Ecuafact.Sdk;
using Ecuafact.Sdk.Contracts;

// client: cliente EcuafactClient - ver SDK .NET
Contexto contexto = await client.GetContextoAsync();
foreach (Contribuyente contribuyente in contexto.Contribuyentes ?? [])
{
    Console.WriteLine(contribuyente.Identificacion);
}
from ecuafact import EcuafactClient

# client: cliente EcuafactClient - ver SDK Python
contexto = client.get_contexto()
for contribuyente in contexto.contribuyentes or []:
    print(contribuyente.identificacion)
import { EcuafactClient } from "@ecuafact/sdk";

// client: cliente EcuafactClient - ver SDK Node.js
const contexto = await client.getContexto();
for (const contribuyente of contexto.contribuyentes ?? []) {
  console.log(contribuyente.identificacion);
}
<?php
use Ecuafact\Sdk\EcuafactClient;

// $client: cliente EcuafactClient - ver SDK PHP
$contexto = $client->getContexto();
foreach ($contexto->contribuyentes ?? [] as $contribuyente) {
    echo $contribuyente->identificacion . PHP_EOL;
}
import com.ecuafact.sdk.EcuafactClient;

// client: cliente EcuafactClient - ver SDK Java
Contexto contexto = client.getContexto();
for (Contribuyente contribuyente : contexto.contribuyentes()) {
    System.out.println(contribuyente.identificacion());
}
{
  "datos": {
    "idCliente": "1f2e3d4c-5b6a-4789-9012-abcdef012345",
    "nombre": "Integracion de ejemplo",
    "contribuyentes": [
      {
        "identificacion": "0123456789",
        "identificacionCompleta": "0123456789001",
        "puedeEmitir": true,
        "puedeRecibir": true,
        "tiposComprobante": ["01", "03", "04", "05", "06", "07"]
      }
    ]
  }
}
Campo Significado
idCliente Cliente de la integracion
contribuyentes[].identificacion Identificacion que usas en las rutas de emision y consulta
contribuyentes[].identificacionCompleta RUC completo de 13 digitos
contribuyentes[].puedeEmitir Indica si el contribuyente puede emitir
contribuyentes[].puedeRecibir Indica si el contribuyente puede recibir comprobantes
contribuyentes[].tiposComprobante Tipos de comprobante habilitados por el plan

Estados de este endpoint#

Codigo HTTP Cuando ocurre Que hacer
200 200 Contexto devuelto Usa identificacion en las rutas
101 401 API Key invalida Revisa la API Key
102 403 Origen de la solicitud no autorizado Revisa la IP registrada para tu API Key

Si un contribuyente no aparece en el contexto, no esta habilitado para tu integracion: solicita su alta. El catalogo completo esta en Errores.

Siguientes pasos#

No se pudo completar la operacion. Recargar ✕