Autenticación

Integra de forma segura con la Admin API utilizando claves de API de administrador a nivel de cuenta transmitidas en el encabezado X-API-KEY.

Para acceso del lado del cliente o de usuarios finales a la Application API, crea claves de API de aplicación con alcance limitado a un solo usuario en su lugar.

​

Claves de API de administrador

Las claves de API de administrador son credenciales a nivel de cuenta con permisos amplios. Úsalas para autenticar solicitudes a la Admin API y, opcionalmente, a la Application API desde entornos de servidor confiables.

Cada cuenta puede crear un máximo de 3 claves de API de administrador desde la página de integración del panel de Trophy.

Trophy realiza un seguimiento y muestra cuándo se creó cada clave de API de administrador en tu cuenta y cuándo se usó por última vez, para que puedas supervisar fácilmente su uso.

Las claves de API de administrador pueden acceder a cualquier usuario y cualquier operación de administrador en tu cuenta. Nunca las expongas en código del lado del cliente, aplicaciones móviles o repositorios públicos.

​

Anatomía de una clave de API de administrador

Cada clave de API de administrador está compuesta por 2 partes separadas por un punto:

{prefix}.{body}

• El prefijo son los primeros 8 caracteres. Es legible y siempre permanecerá igual, por lo que es fácilmente reconocible.
• El cuerpo es la parte secreta y solo se te muestra una vez cuando creas la clave.

Al usar la API, ambas partes de tu clave de API de administrador deben enviarse en el encabezado X-API-KEY.

​

Autenticación de solicitudes

Al realizar solicitudes al Admin API, incluye ambas partes de tu clave de admin API en el encabezado X-API-KEY, o pásala al inicializar un cliente SDK:

cURL

curl https://admin.trophy.so/v1/metrics \
     -H "X-API-KEY: YOUR_API_KEY"

import { TrophyApiClient } from "@trophyso/node";

const trophy = new TrophyApiClient({
  apiKey: "YOUR_API_KEY",
});

from trophy import TrophyApi

client = TrophyApi(
    api_key="YOUR_API_KEY",
)

use Trophy\TrophyClient;

$trophy = new TrophyClient("YOUR_API_KEY");

TrophyApiClient client = TrophyApiClient.builder()
    .apiKey("YOUR_API_KEY")
    .build();

import (
  trophyclient "github.com/trophyso/trophy-go/client"
  "github.com/trophyso/trophy-go/option"
)

client := trophyclient.NewClient(
  option.WithApiKey("YOUR_API_KEY"),
)

var trophy = new TrophyApiClient(
    apiKey: "YOUR_API_KEY"
);

client = Trophy::Client.new(
  api_key: "YOUR_API_KEY"
)

La misma clave autentica las solicitudes del Application API cuando utilizas una clave de admin API desde un entorno del lado del servidor:

cURL

curl https://api.trophy.so/v1/users/user_123/metrics/<key> \
     -H "X-API-KEY: YOUR_API_KEY"

import { TrophyApiClient } from "@trophyso/node";

const trophy = new TrophyApiClient({
  apiKey: "YOUR_API_KEY",
});

from trophy import TrophyApi

client = TrophyApi(
    api_key="YOUR_API_KEY",
)

use Trophy\TrophyClient;

$trophy = new TrophyClient("YOUR_API_KEY");

TrophyApiClient client = TrophyApiClient.builder()
    .apiKey("YOUR_API_KEY")
    .build();

import (
  trophyclient "github.com/trophyso/trophy-go/client"
  "github.com/trophyso/trophy-go/option"
)

client := trophyclient.NewClient(
  option.WithApiKey("YOUR_API_KEY"),
)

var trophy = new TrophyApiClient(
    apiKey: "YOUR_API_KEY"
);

client = Trophy::Client.new(
  api_key: "YOUR_API_KEY"
)

Si no proporcionas una clave API o tu clave API no es válida, recibirás un código de respuesta 401.

​

Administración de claves de admin API

Existen varias operaciones que puedes realizar sobre las claves de admin API desde tu panel de Trophy para gestionar tu integración.

​

Rotación de claves

Las claves de admin API pueden rotarse si deseas cambiarlas por cualquier motivo. En el momento de la rotación, la clave API original dejará de funcionar y cualquier solicitud que aún la utilice comenzará a recibir respuestas 401 de inmediato.

Ten en cuenta que al rotar claves, tanto el prefijo como el cuerpo cambiarán.

​

Revocación de claves

Las claves de admin API también pueden revocarse por completo, momento en el cual pasan a estar Inactivas. En el momento de la revocación, la clave API dejará de funcionar y cualquier solicitud que aún la utilice comenzará a recibir respuestas 401 de inmediato.

Una vez revocada, puedes reactivar la clave API en cualquier momento.

Ni el prefijo ni el cuerpo de la clave cambian cuando se revoca o se reactiva.

​

Eliminación de claves API

Si estás 100% seguro de que ya no necesitas una clave de admin API, pueden eliminarse.

​

Obtener Soporte

¿Quieres ponerte en contacto con el equipo de Trophy? Contáctanos por correo electrónico. ¡Estamos aquí para ayudarte!