Desenrolar entidad
curl --request DELETE \
--url https://api.tupana.ai/v1/credentials/{master_entity_id} \
--header 'Authorization: <api-key>'import requests
url = "https://api.tupana.ai/v1/credentials/{master_entity_id}"
headers = {"Authorization": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: '<api-key>'}};
fetch('https://api.tupana.ai/v1/credentials/{master_entity_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tupana.ai/v1/credentials/{master_entity_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.tupana.ai/v1/credentials/{master_entity_id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.tupana.ai/v1/credentials/{master_entity_id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tupana.ai/v1/credentials/{master_entity_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"error": "VALIDATION_ERROR",
"message": "<string>"
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}Credenciales
Desenrolar Entidad
Elimina la asociación entre el usuario de la api key y la entidad maestra
DELETE
/
credentials
/
{master_entity_id}
Desenrolar entidad
curl --request DELETE \
--url https://api.tupana.ai/v1/credentials/{master_entity_id} \
--header 'Authorization: <api-key>'import requests
url = "https://api.tupana.ai/v1/credentials/{master_entity_id}"
headers = {"Authorization": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: '<api-key>'}};
fetch('https://api.tupana.ai/v1/credentials/{master_entity_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tupana.ai/v1/credentials/{master_entity_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.tupana.ai/v1/credentials/{master_entity_id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.tupana.ai/v1/credentials/{master_entity_id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tupana.ai/v1/credentials/{master_entity_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"error": "VALIDATION_ERROR",
"message": "<string>"
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}Que hace
- Elimina la asociación entre el usuario de la api key y la entidad maestra
- No elimina la entidad maestra ni sus credenciales, solo desvincula al usuario
- Otros usuarios que estén asociados a la misma entidad mantienen su acceso
Ejemplos de uso
- Dejar de administrar una entidad desde la api key actual
- Revertir un enrolamiento hecho por error
- Limpiar entidades que ya no corresponden a la integración
Obtener el master_entity_id
Elmaster_entity_id es el ID unico de la empresa en Tupana que se esta desasociando. Para obtener este ID, debes usar el endpoint /master-entities:
- Buscar la entidad por RUT usando
GET /master-entities?rut=76543210-1 - Obtener el ID de la respuesta (campo
id) - Usar ese ID como
master_entity_iden la ruta del endpoint
Importante
- El usuario de la api key debe estar asociado a la entidad, de lo contrario se retorna
404 - Esta acción no puede deshacerse automáticamente: para volver a acceder a la entidad se debe crear una nueva credencial (ver Crear Credencial)
Authorizations
API Key para autenticación. Debe proporcionarse en el header Authorization con el formato: 'Api-Key YOUR-API-KEY' (incluye el prefijo 'Api-Key ' seguido de tu API key)
Path Parameters
ID de la entidad maestra a desenrolar
Response
Entidad desenrolada exitosamente
