En esta página
Perfil del emisor GET
Lee y actualiza los datos del emisor que aparecen en el RIDE, como el nombre comercial, la dirección y el contacto, y cambia su logo.
El perfil del emisor reúne los datos que mostramos en el RIDE, el PDF del comprobante, y en el correo que enviamos al comprador. Con estos tres endpoints puedes leer ese perfil, cambiar los datos de contacto y subir el logo que se imprime en el RIDE.
Esta página explica cada operación con sus ejemplos, la respuesta campo a campo y los errores posibles. Al terminar tendrás el perfil listo para que tus comprobantes muestren los datos correctos.
GET /v1/contribuyentes/{identificacion}/perfil
PUT /v1/contribuyentes/{identificacion}/perfil
POST /v1/contribuyentes/{identificacion}/perfil/logo
X-Api-Key: <tu API Key>
Cuándo usarlo#
El perfil del emisor incluye el nombre comercial, la dirección matriz, el correo, el teléfono, la ciudad, la provincia y el logo. Puedes usar cada operación según lo que necesites:
- GET: para mostrar en tu sistema los datos que verán tus clientes, o para revisar el perfil antes de emitir por primera vez.
- PUT: para actualizar el perfil cuando el emisor cambia de dirección, teléfono o correo de contacto.
- POST logo: para poner o cambiar el logo del RIDE.
Puedes leer los datos fiscales, como la razón social, el RUC, la obligación de llevar contabilidad y el establecimiento y el punto de emisión configurados, pero no cambiarlos por esta vía. Estas operaciones no consumen cupo.
Antes de empezar#
- Una API Key en la variable de entorno
ECUAFACT_API_KEY. Si todavía no tienes una, crea tu sandbox. - Solo en producción, la IP desde la que llamas registrada para tu integración, como se explica en Autenticación. El sandbox acepta cualquier IP.
- La
identificaciondel contribuyente, que obtienes deGET /v1/contexto. En los ejemplos es0123456789001. - Para cambiar el logo, un archivo
logo.pngo JPEG de hasta 512 KB en la carpeta desde la que ejecutas el ejemplo.
Parámetros comunes#
Las tres operaciones usan estos parámetros.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
identificacion (ruta) |
string | Sí | Identificación del contribuyente tal como la devuelve GET /v1/contexto en identificacion; es la identificación completa del contribuyente, la misma de infoTributaria.ruc. |
X-Api-Key (cabecera) |
string | Sí | Tu API Key. |
Leer el perfil#
Lee el perfil para ver los datos que aparecen hoy en el RIDE de tus comprobantes.
GET /v1/contribuyentes/{identificacion}/perfil
Importante
Ambiente de pruebas: sin validez fiscal.
curl -s "https://api-sandbox.mynexusapi.com/v1/contribuyentes/0123456789001/perfil" \
-H "X-Api-Key: $ECUAFACT_API_KEY"
using System.Net.Http;
string apiKey = Environment.GetEnvironmentVariable("ECUAFACT_API_KEY")!;
using var http = new HttpClient { BaseAddress = new Uri("https://api-sandbox.mynexusapi.com") };
http.DefaultRequestHeaders.Add("X-Api-Key", apiKey);
using HttpResponseMessage respuesta = await http.GetAsync("/v1/contribuyentes/0123456789001/perfil");
Console.WriteLine($"{(int)respuesta.StatusCode} {await respuesta.Content.ReadAsStringAsync()}");
import os
import requests
r = requests.get(
"https://api-sandbox.mynexusapi.com/v1/contribuyentes/0123456789001/perfil",
headers={"X-Api-Key": os.environ["ECUAFACT_API_KEY"]},
timeout=30,
)
print(r.status_code, r.text)
// Node.js 18 o superior. Guarda como perfil.mjs y ejecuta: node perfil.mjs
const res = await fetch('https://api-sandbox.mynexusapi.com/v1/contribuyentes/0123456789001/perfil', {
headers: { 'X-Api-Key': process.env.ECUAFACT_API_KEY }
});
console.log(res.status, await res.text());
<?php
$ch = curl_init('https://api-sandbox.mynexusapi.com/v1/contribuyentes/0123456789001/perfil');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['X-Api-Key: ' . getenv('ECUAFACT_API_KEY')],
]);
$cuerpo = curl_exec($ch);
$estado = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $estado . ' ' . $cuerpo . PHP_EOL;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
// Dentro de: public static void main(String[] args) throws Exception
HttpClient cliente = HttpClient.newHttpClient();
HttpRequest peticion = HttpRequest.newBuilder()
.uri(URI.create("https://api-sandbox.mynexusapi.com/v1/contribuyentes/0123456789001/perfil"))
.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;
using var client = EcuafactClient.Create(new EcuafactClientOptions
{
BaseAddress = new Uri("https://api-sandbox.mynexusapi.com/"),
ApiKey = Environment.GetEnvironmentVariable("ECUAFACT_API_KEY")!
});
PerfilEmisor perfil = await client.GetPerfilAsync("0123456789001");
Console.WriteLine($"{perfil.RazonSocial} / {perfil.NombreComercial} / {perfil.Correo}");
import os
from ecuafact import EcuafactClient, EcuafactClientOptions
client = EcuafactClient(EcuafactClientOptions(
base_address="https://api-sandbox.mynexusapi.com/",
api_key=os.environ["ECUAFACT_API_KEY"],
))
perfil = client.get_perfil("0123456789001")
print(perfil.razon_social, "/", perfil.nombre_comercial, "/", perfil.correo)
// Node.js 18 o superior. Guarda como perfil-sdk.mjs y ejecuta: node perfil-sdk.mjs
import { EcuafactClient } from '@ecuafact/sdk';
const client = new EcuafactClient({
baseAddress: 'https://api-sandbox.mynexusapi.com/',
apiKey: process.env.ECUAFACT_API_KEY
});
const perfil = await client.getPerfil('0123456789001');
console.log(perfil.razonSocial, '/', perfil.nombreComercial, '/', perfil.correo);
<?php
require 'vendor/autoload.php';
use Ecuafact\Sdk\EcuafactClient;
use Ecuafact\Sdk\EcuafactClientOptions;
$client = new EcuafactClient(new EcuafactClientOptions(
baseAddress: 'https://api-sandbox.mynexusapi.com/',
apiKey: getenv('ECUAFACT_API_KEY'),
));
$perfil = $client->getPerfil('0123456789001');
echo $perfil->razonSocial . ' / ' . $perfil->nombreComercial . ' / ' . $perfil->correo . PHP_EOL;
import com.ecuafact.sdk.EcuafactClient;
import com.ecuafact.sdk.EcuafactClientOptions;
import com.ecuafact.sdk.contracts.PerfilEmisor;
// Dentro de: public static void main(String[] args) throws Exception
EcuafactClient client = new EcuafactClient(
EcuafactClientOptions.create("https://api-sandbox.mynexusapi.com/", System.getenv("ECUAFACT_API_KEY")));
PerfilEmisor perfil = client.getPerfil("0123456789001");
System.out.println(perfil.razonSocial + " / " + perfil.nombreComercial + " / " + perfil.correo);
# Resultado esperado: el perfil del emisor, con los datos que aparecen en el RIDE.
ecuafact perfil-emisor ver --entorno sandbox
Respuesta#
La API responde 200 OK con el perfil del emisor en el primer nivel del JSON. Las tres operaciones, leer, actualizar y cambiar el logo, devuelven esta misma forma, con los datos vigentes después del cambio.
{
"identificacion": "0123456789001",
"razonSocial": "EMPRESA DE PRUEBA S.A.",
"nombreComercial": "Prueba",
"direccionMatriz": "Av. Principal 123",
"direccionEstablecimiento": "Av. Principal 123",
"codigoEstablecimiento": "001",
"codigoPuntoEmision": "001",
"moneda": "DOLAR",
"obligadoContabilidad": true,
"correo": "contacto@ejemplo.com",
"telefono": "042345678",
"ciudad": "GUAYAQUIL",
"provincia": "GUAYAS",
"pais": "ECUADOR",
"logo": "0123456789001_Logo.jpg"
}
| Campo | Tipo | Editable | Descripción |
|---|---|---|---|
identificacion |
string | No | Identificación completa del emisor, la misma de infoTributaria.ruc. |
razonSocial |
string | No | Razón social registrada en el SRI. |
nombreComercial |
string o null |
Sí | Nombre comercial que aparece en el RIDE. |
direccionMatriz |
string o null |
Sí | Dirección de la matriz. |
direccionEstablecimiento |
string o null |
No | Dirección del establecimiento configurado. |
codigoEstablecimiento |
string o null |
No | Código del establecimiento configurado, de 3 dígitos. |
codigoPuntoEmision |
string o null |
No | Código del punto de emisión configurado, de 3 dígitos. |
moneda |
string o null |
No | Moneda configurada. |
obligadoContabilidad |
boolean | No | true si el emisor está obligado a llevar contabilidad. |
correo |
string o null |
Sí | Correo de contacto del emisor. |
telefono |
string o null |
Sí | Teléfono de contacto. |
ciudad |
string o null |
Sí | Ciudad. |
provincia |
string o null |
Sí | Provincia. |
pais |
string o null |
No | País. |
logo |
string o null |
Por POST .../logo |
Referencia del logo registrado, o null si no hay logo. No es una URL descargable. |
Actualizar el perfil#
PUT /v1/contribuyentes/{identificacion}/perfil
Content-Type: application/json
Envía solo los campos que quieres cambiar. Un campo que omites o envías como
null conserva su valor actual.
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
nombreComercial |
string | No | Nuevo nombre comercial, hasta 300 caracteres. |
direccionMatriz |
string | No | Nueva dirección de la matriz, hasta 300 caracteres. Si se envía, no puede quedar vacía ni contener solo espacios. |
correo |
string | No | Una dirección de correo válida, hasta 200 caracteres. |
telefono |
string | No | Nuevo teléfono, hasta 50 caracteres. |
ciudad |
string | No | Nueva ciudad, hasta 100 caracteres. |
provincia |
string | No | Nueva provincia, hasta 100 caracteres. |
Los textos deben ocupar una sola línea, sin caracteres de control ni separadores
Unicode de línea o párrafo. Los campos opcionales admiten "" para vaciarlos;
direccionMatriz debe conservar una dirección. Si un campo no cumple estas reglas,
la respuesta es 400 con codEstado 3003 y el campo indicado en errores.
Nota
Solo se aceptan estos seis campos. Si envías otro, como razonSocial o
logo, la API responde 400 con el codEstado 3003 (solicitud_invalida) y no cambia nada. Un texto vacío
("") no equivale a omitir el campo, porque se envía como valor nuevo.
Guarda este JSON como perfil.json. Los ejemplos lo envían para cambiar el
nombre comercial, el correo y el teléfono.
{
"nombreComercial": "Prueba",
"correo": "contacto@ejemplo.com",
"telefono": "042345678"
}
curl -s -X PUT "https://api-sandbox.mynexusapi.com/v1/contribuyentes/0123456789001/perfil" \
-H "X-Api-Key: $ECUAFACT_API_KEY" \
-H "Content-Type: application/json" \
-d @perfil.json
using System.Net.Http;
using System.Text;
string apiKey = Environment.GetEnvironmentVariable("ECUAFACT_API_KEY")!;
using var http = new HttpClient { BaseAddress = new Uri("https://api-sandbox.mynexusapi.com") };
http.DefaultRequestHeaders.Add("X-Api-Key", apiKey);
using var peticion = new HttpRequestMessage(HttpMethod.Put, "/v1/contribuyentes/0123456789001/perfil");
peticion.Content = new StringContent(
await File.ReadAllTextAsync("perfil.json"), Encoding.UTF8, "application/json");
using HttpResponseMessage respuesta = await http.SendAsync(peticion);
Console.WriteLine($"{(int)respuesta.StatusCode} {await respuesta.Content.ReadAsStringAsync()}");
import json
import os
import requests
with open("perfil.json", encoding="utf-8") as archivo:
cuerpo = json.load(archivo)
r = requests.put(
"https://api-sandbox.mynexusapi.com/v1/contribuyentes/0123456789001/perfil",
headers={"X-Api-Key": os.environ["ECUAFACT_API_KEY"]},
json=cuerpo,
timeout=30,
)
print(r.status_code, r.text)
// Node.js 18 o superior. Guarda como actualizar-perfil.mjs y ejecuta: node actualizar-perfil.mjs
import { readFile } from 'node:fs/promises';
const res = await fetch('https://api-sandbox.mynexusapi.com/v1/contribuyentes/0123456789001/perfil', {
method: 'PUT',
headers: {
'X-Api-Key': process.env.ECUAFACT_API_KEY,
'Content-Type': 'application/json'
},
body: await readFile('perfil.json', 'utf8')
});
console.log(res.status, await res.text());
<?php
$ch = curl_init('https://api-sandbox.mynexusapi.com/v1/contribuyentes/0123456789001/perfil');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_HTTPHEADER => [
'X-Api-Key: ' . getenv('ECUAFACT_API_KEY'),
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => file_get_contents('perfil.json'),
]);
$cuerpo = curl_exec($ch);
$estado = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $estado . ' ' . $cuerpo . PHP_EOL;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.file.Files;
import java.nio.file.Path;
// Dentro de: public static void main(String[] args) throws Exception
HttpClient cliente = HttpClient.newHttpClient();
HttpRequest peticion = HttpRequest.newBuilder()
.uri(URI.create("https://api-sandbox.mynexusapi.com/v1/contribuyentes/0123456789001/perfil"))
.header("X-Api-Key", System.getenv("ECUAFACT_API_KEY"))
.header("Content-Type", "application/json")
.PUT(HttpRequest.BodyPublishers.ofString(Files.readString(Path.of("perfil.json"))))
.build();
HttpResponse<String> respuesta = cliente.send(peticion, HttpResponse.BodyHandlers.ofString());
System.out.println(respuesta.statusCode() + " " + respuesta.body());
using Ecuafact.Sdk;
using Ecuafact.Sdk.Contracts;
using var client = EcuafactClient.Create(new EcuafactClientOptions
{
BaseAddress = new Uri("https://api-sandbox.mynexusapi.com/"),
ApiKey = Environment.GetEnvironmentVariable("ECUAFACT_API_KEY")!
});
PerfilEmisor perfil = await client.ActualizarPerfilAsync("0123456789001", new PerfilEmisorUpdate
{
NombreComercial = "Prueba",
Correo = "contacto@ejemplo.com",
Telefono = "042345678"
});
Console.WriteLine($"{perfil.NombreComercial} / {perfil.Correo}");
import os
from ecuafact import EcuafactClient, EcuafactClientOptions
from ecuafact.models import PerfilEmisorUpdate
client = EcuafactClient(EcuafactClientOptions(
base_address="https://api-sandbox.mynexusapi.com/",
api_key=os.environ["ECUAFACT_API_KEY"],
))
cambios = PerfilEmisorUpdate(nombre_comercial="Prueba", correo="contacto@ejemplo.com", telefono="042345678")
perfil = client.actualizar_perfil("0123456789001", cambios)
print(perfil.nombre_comercial, "/", perfil.correo)
// Node.js 18 o superior. Guarda como actualizar-perfil-sdk.mjs y ejecuta: node actualizar-perfil-sdk.mjs
import { EcuafactClient } from '@ecuafact/sdk';
const client = new EcuafactClient({
baseAddress: 'https://api-sandbox.mynexusapi.com/',
apiKey: process.env.ECUAFACT_API_KEY
});
const perfil = await client.actualizarPerfil('0123456789001', {
nombreComercial: 'Prueba',
correo: 'contacto@ejemplo.com',
telefono: '042345678'
});
console.log(perfil.nombreComercial, '/', perfil.correo);
<?php
require 'vendor/autoload.php';
use Ecuafact\Sdk\Contracts\PerfilEmisorUpdate;
use Ecuafact\Sdk\EcuafactClient;
use Ecuafact\Sdk\EcuafactClientOptions;
$client = new EcuafactClient(new EcuafactClientOptions(
baseAddress: 'https://api-sandbox.mynexusapi.com/',
apiKey: getenv('ECUAFACT_API_KEY'),
));
$cambios = new PerfilEmisorUpdate();
$cambios->nombreComercial = 'Prueba';
$cambios->correo = 'contacto@ejemplo.com';
$cambios->telefono = '042345678';
$perfil = $client->actualizarPerfil('0123456789001', $cambios);
echo $perfil->nombreComercial . ' / ' . $perfil->correo . PHP_EOL;
import com.ecuafact.sdk.EcuafactClient;
import com.ecuafact.sdk.EcuafactClientOptions;
import com.ecuafact.sdk.contracts.PerfilEmisor;
import com.ecuafact.sdk.contracts.PerfilEmisorUpdate;
// Dentro de: public static void main(String[] args) throws Exception
EcuafactClient client = new EcuafactClient(
EcuafactClientOptions.create("https://api-sandbox.mynexusapi.com/", System.getenv("ECUAFACT_API_KEY")));
PerfilEmisorUpdate cambios = new PerfilEmisorUpdate();
cambios.nombreComercial = "Prueba";
cambios.correo = "contacto@ejemplo.com";
cambios.telefono = "042345678";
PerfilEmisor perfil = client.actualizarPerfil("0123456789001", cambios);
System.out.println(perfil.nombreComercial + " / " + perfil.correo);
# Resultado esperado: el perfil completo, con el nombre comercial, el correo y el teléfono nuevos.
ecuafact perfil-emisor editar --nombre-comercial "Prueba" --correo contacto@ejemplo.com --telefono 042345678 --entorno sandbox
La API responde 200 OK con el perfil completo ya actualizado, con la misma forma que en Leer el perfil. Sabrás que funcionó si los campos que enviaste aparecen con sus valores nuevos.
Cambiar el logo#
POST /v1/contribuyentes/{identificacion}/perfil/logo
Content-Type: multipart/form-data
Sube la imagen como formulario multipart/form-data con un único campo de
archivo llamado logo. El logo nuevo reemplaza al anterior.
| Regla | Detalle |
|---|---|
| Nombre del campo | logo |
| Formato | Imagen PNG o JPEG válida. El tipo de la parte del formulario debe ser exactamente image/png o image/jpeg y coincidir con el contenido. |
| Tamaño | Mayor que 0 y hasta 512 KB (524.288 bytes). |
| Dimensiones | Hasta 16.777.216 píxeles en total (ancho por alto). |
| Cuerpo completo | Hasta 1 MiB incluyendo el formulario. |
Nota
Indica de forma explícita el tipo de la parte del formulario, como en los
ejemplos. La API valida el contenido y el tipo declarado, sin depender de la extensión del archivo. Si tu
cliente HTTP lo envía como application/octet-stream, responde 400.
Los ejemplos suben el archivo logo.png de la carpeta actual.
curl -s -X POST "https://api-sandbox.mynexusapi.com/v1/contribuyentes/0123456789001/perfil/logo" \
-H "X-Api-Key: $ECUAFACT_API_KEY" \
-F "logo=@logo.png;type=image/png"
using System.Net.Http;
using System.Net.Http.Headers;
string apiKey = Environment.GetEnvironmentVariable("ECUAFACT_API_KEY")!;
using var http = new HttpClient { BaseAddress = new Uri("https://api-sandbox.mynexusapi.com") };
http.DefaultRequestHeaders.Add("X-Api-Key", apiKey);
using var imagen = new ByteArrayContent(await File.ReadAllBytesAsync("logo.png"));
imagen.Headers.ContentType = new MediaTypeHeaderValue("image/png");
using var formulario = new MultipartFormDataContent { { imagen, "logo", "logo.png" } };
using HttpResponseMessage respuesta = await http.PostAsync("/v1/contribuyentes/0123456789001/perfil/logo", formulario);
Console.WriteLine($"{(int)respuesta.StatusCode} {await respuesta.Content.ReadAsStringAsync()}");
import os
import requests
with open("logo.png", "rb") as imagen:
r = requests.post(
"https://api-sandbox.mynexusapi.com/v1/contribuyentes/0123456789001/perfil/logo",
headers={"X-Api-Key": os.environ["ECUAFACT_API_KEY"]},
files={"logo": ("logo.png", imagen, "image/png")},
timeout=60,
)
print(r.status_code, r.text)
// Node.js 18 o superior. Guarda como logo.mjs y ejecuta: node logo.mjs
import { readFile } from 'node:fs/promises';
const formulario = new FormData();
formulario.append('logo', new Blob([await readFile('logo.png')], { type: 'image/png' }), 'logo.png');
const res = await fetch('https://api-sandbox.mynexusapi.com/v1/contribuyentes/0123456789001/perfil/logo', {
method: 'POST',
headers: { 'X-Api-Key': process.env.ECUAFACT_API_KEY },
body: formulario
});
console.log(res.status, await res.text());
<?php
$ch = curl_init('https://api-sandbox.mynexusapi.com/v1/contribuyentes/0123456789001/perfil/logo');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => ['X-Api-Key: ' . getenv('ECUAFACT_API_KEY')],
CURLOPT_POSTFIELDS => ['logo' => new CURLFile('logo.png', 'image/png', 'logo.png')],
]);
$cuerpo = curl_exec($ch);
$estado = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $estado . ' ' . $cuerpo . PHP_EOL;
import java.io.ByteArrayOutputStream;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.UUID;
// Dentro de: public static void main(String[] args) throws Exception
String limite = UUID.randomUUID().toString();
ByteArrayOutputStream cuerpo = new ByteArrayOutputStream();
cuerpo.write(("--" + limite + "\r\n"
+ "Content-Disposition: form-data; name=\"logo\"; filename=\"logo.png\"\r\n"
+ "Content-Type: image/png\r\n\r\n").getBytes(StandardCharsets.UTF_8));
cuerpo.write(Files.readAllBytes(Path.of("logo.png")));
cuerpo.write(("\r\n--" + limite + "--\r\n").getBytes(StandardCharsets.UTF_8));
HttpClient cliente = HttpClient.newHttpClient();
HttpRequest peticion = HttpRequest.newBuilder()
.uri(URI.create("https://api-sandbox.mynexusapi.com/v1/contribuyentes/0123456789001/perfil/logo"))
.header("X-Api-Key", System.getenv("ECUAFACT_API_KEY"))
.header("Content-Type", "multipart/form-data; boundary=" + limite)
.POST(HttpRequest.BodyPublishers.ofByteArray(cuerpo.toByteArray()))
.build();
HttpResponse<String> respuesta = cliente.send(peticion, HttpResponse.BodyHandlers.ofString());
System.out.println(respuesta.statusCode() + " " + respuesta.body());
using Ecuafact.Sdk;
using Ecuafact.Sdk.Contracts;
using var client = EcuafactClient.Create(new EcuafactClientOptions
{
BaseAddress = new Uri("https://api-sandbox.mynexusapi.com/"),
ApiKey = Environment.GetEnvironmentVariable("ECUAFACT_API_KEY")!
});
byte[] png = await File.ReadAllBytesAsync("logo.png");
PerfilEmisor perfil = await client.ActualizarLogoAsync("0123456789001", png, "image/png", "logo.png");
Console.WriteLine($"Logo vigente: {perfil.Logo}");
// Node.js 18 o superior. Guarda como logo-sdk.mjs y ejecuta: node logo-sdk.mjs
import { readFile } from 'node:fs/promises';
import { EcuafactClient } from '@ecuafact/sdk';
const client = new EcuafactClient({
baseAddress: 'https://api-sandbox.mynexusapi.com/',
apiKey: process.env.ECUAFACT_API_KEY
});
const png = await readFile('logo.png');
const perfil = await client.actualizarLogo('0123456789001', png, 'image/png', 'logo.png');
console.log('Logo vigente:', perfil.logo);
import os
from ecuafact import EcuafactClient, EcuafactClientOptions
client = EcuafactClient(EcuafactClientOptions(
base_address="https://api-sandbox.mynexusapi.com/",
api_key=os.environ["ECUAFACT_API_KEY"],
))
with open("logo.png", "rb") as archivo:
perfil = client.actualizar_logo("0123456789001", archivo.read(), "image/png", "logo.png")
print("Logo vigente:", perfil.logo)
<?php
require 'vendor/autoload.php';
use Ecuafact\Sdk\EcuafactClient;
use Ecuafact\Sdk\EcuafactClientOptions;
$client = new EcuafactClient(new EcuafactClientOptions(
baseAddress: 'https://api-sandbox.mynexusapi.com/',
apiKey: getenv('ECUAFACT_API_KEY'),
));
$perfil = $client->actualizarLogo('0123456789001', file_get_contents('logo.png'), 'image/png', 'logo.png');
echo 'Logo vigente: ' . $perfil->logo . PHP_EOL;
import com.ecuafact.sdk.EcuafactClient;
import com.ecuafact.sdk.EcuafactClientOptions;
import com.ecuafact.sdk.contracts.PerfilEmisor;
import java.nio.file.Files;
import java.nio.file.Path;
// Dentro de: public static void main(String[] args) throws Exception
EcuafactClient client = new EcuafactClient(
EcuafactClientOptions.create("https://api-sandbox.mynexusapi.com/", System.getenv("ECUAFACT_API_KEY")));
byte[] png = Files.readAllBytes(Path.of("logo.png"));
PerfilEmisor perfil = client.actualizarLogo("0123456789001", png, "image/png", "logo.png");
System.out.println("Logo vigente: " + perfil.logo);
# Resultado esperado: el mensaje "Logo actualizado." y el perfil con el campo logo lleno.
ecuafact perfil-emisor logo logo.png --entorno sandbox
Puedes cambiar el logo con nuestros SDK de .NET, Node.js, Python, Java y PHP. Si usas otro lenguaje, usa los ejemplos HTTP o el CLI.
La API responde 200 OK con el perfil completo, con la misma forma que en
Leer el perfil. Sabrás que funcionó si logo trae un valor.
Estados de este endpoint#
Esta tabla reúne las respuestas de las tres operaciones del perfil.
codEstado |
HTTP | Operación | Cuándo ocurre | Qué hacer |
|---|---|---|---|---|
| - | 200 | Todas | Se leyó o se actualizó el perfil. | Usa el perfil devuelto: ya refleja el cambio. |
3003 (solicitud_invalida) |
400 | PUT | El JSON está mal formado, trae un campo no editable o algún valor incumple las longitudes o el formato indicado. | Envía solo los seis campos editables y corrige el campo indicado en errores. |
3003 (solicitud_invalida) |
400 | POST logo | Falta el campo logo, el archivo está vacío, supera 512 KB o 16.777.216 píxeles, no se puede decodificar como imagen admitida o no coincide con el tipo declarado. errores trae el detalle. |
Corrige el archivo o el tipo declarado y vuelve a subirlo. |
3006 (cuerpo_excedido) |
413 | POST logo, PUT | El cuerpo completo supera 1 MiB. | Reduce el tamaño de la imagen. |
| sin cuerpo | 415 | PUT, POST logo | El Content-Type no es application/json en el PUT ni multipart/form-data en el POST del logo. |
Envía el Content-Type correcto. |
3009 (credenciales_invalidas) |
401 | Todas | La API Key falta o no es válida. | Revisa la API Key, como se explica en Autenticación. |
3010 (ip_no_autorizada) |
403 | Todas | En producción, la IP de la que sale la llamada no está registrada o no se pudo identificar. El sandbox no lo devuelve. | Registra tu IP en Cuenta > IP permitidas o llama sin proxies que oculten el origen. |
3011 (acceso_denegado) |
403 | Todas | El contribuyente no está habilitado para tu API Key en este ambiente, o tu API Key está limitada y no incluye el scope perfil:leer (leer) ni perfil:escribir (actualizar y cambiar el logo). |
Usa la identificacion de /v1/contexto. |
3013 (no_encontrado) |
404 | Todas | No se encontró el perfil del emisor. | Contacta a soporte, porque el emisor no está configurado por completo. |
5005 (limite_solicitudes) |
429 | Todas | Superaste el límite de solicitudes. | Espera los segundos que indica Retry-After y reintenta. |
5003 (error_dependencia) |
502 | Todas | Ocurrió un error al leer el perfil o no se aceptó la actualización, por ejemplo por un valor con un formato que no se admite. | Revisa los valores enviados; si son correctos, reintenta en unos minutos. |
5004 (tiempo_agotado) |
504 | Todas | No pudimos completar la operación a tiempo. | Reintenta en unos minutos; lee el perfil para confirmar si el cambio se aplicó. |
5001 (error_interno) |
500 | PUT, POST logo | Ocurrió un error inesperado, por ejemplo una falla de comunicación al guardar. | Lee el perfil para ver si el cambio se aplicó; si no, reintenta. Si persiste, contacta a soporte con X-Correlation-Id. |
El catálogo completo de codEstado está en Errores.
Siguientes pasos#
- Descargar PDF: comprueba cómo se ve el RIDE con los datos y el logo actualizados.
- Primeros pasos: emite tu primer comprobante con el perfil listo.