Autenticación

Autentícate con la API de la aplicación usando claves de API de aplicación con ámbito de usuario transmitidas en el encabezado X-API-KEY.

​

Tipos de clave de API

La API de la aplicación acepta dos tipos de claves de API:

Tipo de clave	Ámbito	Dónde usar	¿Segura del lado del cliente?
Claves de API de aplicación	Usuario individual	Solo API de la aplicación	Sí
Claves de API de administrador	Cuenta completa	API de la aplicación y API de administrador	No

Usa claves de API de aplicación cuando desees que los usuarios finales o las aplicaciones cliente llamen a la API de la aplicación con permisos limitados a un solo usuario. Usa claves de API de administrador para integraciones de servidor confiables que requieran acceso amplio.

​

Claves de API de aplicación

Las claves de API de aplicación tienen ámbito de un usuario específico. Cada clave solo puede realizar operaciones de la API de la aplicación en nombre del usuario para el que fue creada, lo que las hace seguras para exponerlas en entornos del lado del cliente.

Las claves de API de aplicación no se pueden usar con la API de administrador.

​

Crear claves de API de aplicación

Crea claves de API de aplicación con la API de administrador. Autentícate en esa solicitud con una clave de API de administrador.

Puedes crear claves para hasta 100 usuarios por solicitud. El valor completo de la clave se devuelve una sola vez en el momento de la creación y no se puede recuperar nuevamente—guárdala de forma segura o entrégala al cliente de inmediato.

cURL

curl -X POST https://admin.trophy.so/v1/application-api-keys \
     -H "X-API-KEY: <api-key>" \
     -H "Content-Type: application/json" \
     -d '[
       { "userId": "user_123" },
       { "userId": "user_456" }
     ]'

await trophy.admin.applicationApiKeys.create([
  { userId: "user_123" },
  { userId: "user_456" },
]);

client.admin.application_api_keys.create(
    request=[
        CreateApplicationKeyRequestItem(
            user_id="user_123",
        ),
        CreateApplicationKeyRequestItem(
            user_id="user_456",
        ),
    ],
)

$trophy->admin->applicationApiKeys->create([
    ['userId' => 'user_123'],
    ['userId' => 'user_456'],
]);

CreateApplicationKeysResponse response = client.admin().applicationApiKeys().create(
  List.of(
    CreateApplicationKeyRequestItem.builder().userId("user_123").build(),
    CreateApplicationKeyRequestItem.builder().userId("user_456").build()
  )
);

response, err := client.Admin.ApplicationApiKeys.Create(
    context.TODO(),
    []*api.CreateApplicationKeyRequestItem{
        {UserId: "user_123"},
        {UserId: "user_456"},
    },
)

await trophy.Admin.ApplicationApiKeys.CreateAsync(new[]
{
    new CreateApplicationKeyRequestItem { UserId = "user_123" },
    new CreateApplicationKeyRequestItem { UserId = "user_456" },
});

result = client.admin.application_api_keys.create([
  { user_id: 'user_123' },
  { user_id: 'user_456' }
])

Una respuesta exitosa incluye el ID de la clave (utilizado posteriormente para eliminar la clave), el ID de usuario, la clave completa y un prefijo legible:

{
  "created": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "userId": "user_123",
      "key": "app_XXXXX.YOUR_API_KEY",
      "prefix": "app_XXXXX"
    }
  ],
  "issues": []
}

​

Anatomía de una clave de API de aplicación

Cada clave de API de aplicación se compone de 2 partes separadas por un punto:

{prefix}.{body}

• El prefijo identifica la clave (por ejemplo app_XXXXX) y es seguro para registrar o mostrar.
• El cuerpo es la parte secreta, y solo se muestra una vez cuando creas la clave.

Al usar el API, ambas partes de tu clave de API de aplicación deben enviarse en el encabezado X-API-KEY.

​

Autenticación de solicitudes

Incluye la clave de API de aplicación completa en el encabezado X-API-KEY en las solicitudes del Application API, o pásala al inicializar un cliente SDK. La clave solo autoriza operaciones para el usuario al que está vinculada; las solicitudes para otros usuarios devuelven un error.

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 de API, o tu clave de API no es válida, recibirás un código de respuesta 401.

​

Eliminación de claves de API de aplicación

Elimina las claves de API de aplicación por ID con el Admin API. Usa el UUID devuelto cuando se creó la clave.

cURL

curl -X DELETE "https://admin.trophy.so/v1/application-api-keys?ids=550e8400-e29b-41d4-a716-446655440000" \
     -H "X-API-KEY: <api-key>"

await trophy.admin.applicationApiKeys.delete({
  ids: ["550e8400-e29b-41d4-a716-446655440000"],
});

client.admin.application_api_keys.delete(
    ids=["550e8400-e29b-41d4-a716-446655440000"],
)

$trophy->admin->applicationApiKeys->delete([
    'ids' => ['550e8400-e29b-41d4-a716-446655440000'],
]);

DeleteApplicationKeysResponse response = client.admin().applicationApiKeys().delete(
  ApplicationApiKeysDeleteRequest.builder()
    .ids(List.of("550e8400-e29b-41d4-a716-446655440000"))
    .build()
);

response, err := client.Admin.ApplicationApiKeys.Delete(
    context.TODO(),
    &admin.ApplicationApiKeysDeleteRequest{
        Ids: []*string{
            api.String("550e8400-e29b-41d4-a716-446655440000"),
        },
    },
)

await trophy.Admin.ApplicationApiKeys.DeleteAsync(new ApplicationApiKeysDeleteRequest
{
    Ids = new[] { "550e8400-e29b-41d4-a716-446655440000" },
});

result = client.admin.application_api_keys.delete(
  ids: ['550e8400-e29b-41d4-a716-446655440000']
)

​

Obtener soporte

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