Uso de tu clave API
Todos los puntos de conexión de la API descritos en este documento requieren una clave API en forma de un OAuth 2.0 Bearer Token, que debe incluirse en el encabezado de autorización de cada solicitud. Las siguientes instrucciones y ejemplos explican el proceso para utilizar la API de Junkipedia con esta clave.
Obtener una clave API
Una clave API válida será una cadena de dígitos combinada con letras mayúsculas y minúsculas. En los ejemplos siguientes, utilizaremos Xyz123ApiKey como marcador de posición para tu clave API real.
Puedes obtener una clave API con tu cuenta de Junkipedia.org siguiendo estos pasos:
Inicia sesión en Junkipedia.org y navega a la página de tu cuenta de usuario desde el menú desplegable bajo el ícono de tu perfil en la esquina superior derecha de la ventana.
Haz clic en "Manage API Keys" (Administrar claves API).
Puedes utilizar cualquiera de las claves API listadas, a menos que estén deshabilitadas. Si no hay claves disponibles, haz clic en "Create API Key" (Crear clave API).
Preparar el encabezado de solicitud con la clave API
El encabezado de cada solicitud debe incluir una línea de autorización similar a la siguiente:
Authorization: Bearer Xyz123ApiKey
Prepara una línea de autorización en este formato utilizando tu propia clave API.
Determinar el método de solicitud, endpoint, entradas y URL
Utiliza la lista de endpoints disponibles para seleccionar un endpoint y método de solicitud deseado. Por ejemplo, la solicitud GET /posts utiliza el método "GET" con el endpoint "/posts".
Al realizar cualquier solicitud desde la API de Junkipedia, el endpoint se agrega a la siguiente ruta base común que identifica el servidor de la API de Junkipedia:
Si la solicitud incluye parámetros de entrada en la cadena de consulta, la URL incluirá un "?" agregado después del nombre del endpoint, seguido de los parámetros codificados en la URL. Se proporcionan ejemplos de parámetros disponibles en la documentación de cada endpoint.
Si la solicitud acepta una entrada a través del cuerpo de la solicitud, esta se proporcionará en forma de un objeto JSON. Los ejemplos apropiados aparecerán en la documentación de cada endpoint. En general, un endpoint puede aceptar parámetros de entrada ya sea a través de la cadena de consulta o del cuerpo de la solicitud, pero no de ambas formas.
Redactar y emitir la solicitud
Utilizando un lenguaje de programación, script u otra herramienta, los elementos mencionados anteriormente pueden combinarse y emitirse como una solicitud. El siguiente ejemplo utiliza CURL para emitir una solicitud GET /posts sin ningún parámetro de entrada.
curl --header 'Authorization: Bearer Xyz123ApiKey' \ --request GET 'https://www.junkipedia.org/api/v1/posts'
Note that the backslash character at the end of the first line in the command above is simply there to cause the newline character to be ignored so that the command can span two lines.
Nota que el carácter de barra invertida al final de la primera línea en el comando anterior simplemente está ahí para hacer que el carácter de nueva línea sea ignorado, de modo que el comando pueda extenderse a dos líneas.
El siguiente comando emite una solicitud al mismo endpoint, pero esta vez pasando un parámetro en una cadena de consulta codificada en URL.
curl --header 'Authorization: Bearer Xyz123ApiKey' \ --request GET 'https://www.junkipedia.org/api/v1/posts?keyword=potus'
Last updated