Documentación API GNA

Introducción

En la era digital actual, la capacidad de generar números aleatorios es crucial para una amplia variedad de aplicaciones, desde la seguridad informática hasta la simulación y el análisis estadístico. La nueva API de generación de números aleatorios está diseñada para proporcionar una solución robusta y flexible para cualquier necesidad que requiera números aleatorios dentro de un rango específico.

Objetivo de la API

El objetivo principal de esta API es permitir a los desarrolladores generar números aleatorios de manera eficiente y segura dentro de un rango numérico definido por el usuario. La API está diseñada para ser fácil de integrar en cualquier aplicación, ofreciendo endpoints simples y claros que facilitan su uso.

Características Clave

  • Rangos Personalizables: Los usuarios pueden especificar el rango de números aleatorios que desean generar, asegurando que los números producidos sean siempre relevantes para su aplicación específica.
  • Seguridad y Confiabilidad: Utiliza algoritmos de generación de números aleatorios de alta calidad que garantizan la aleatoriedad y la imprevisibilidad de los números generados, lo cual es esencial para aplicaciones que dependen de la seguridad.
  • Facilidad de Integración: La API está diseñada para ser utilizada con cualquier lenguaje de programación que soporte solicitudes HTTP, lo que la hace extremadamente versátil.
  • Escalabilidad: Puede manejar una gran cantidad de solicitudes simultáneamente, lo que la hace adecuada tanto para aplicaciones pequeñas como para sistemas a gran escala.
  • Autenticación

    El API de GNA utiliza "Authorization Bearer Access" como método de autenticación. Todos los request que se realicen deben incluir el header Authorization y tipo Bearer.

    El acceso al API se realiza utilizando el token otorgado al usuario registrado en GNA.

    Token de acceso

    API Endpoint

    URL: https://gna.bpo.lat/api.php

    Método: POST

    Headers Authentication

    Incluye el token de autenticación en el header Authorization utilizando el esquema Bearer:

    Authorization: Bearer <tu_token>

    Parámetros

    Nombre Tipo Descripción
    init_value integer Valor inicial a ser procesado.
    end_value integer Valor final a ser procesado.

    Ejemplos

    Utilizando curl:

    curl -X POST -H "Authorization: Bearer HGKUJFJSHJDKRUJG7J3854J98DJEUHFJSJGKRJ76843UJFISMF9WJGHT7J693EEW" -d "init_value=9" -d "end_value=99" https://gna.bpo.lat/api.php

    Utilizando Postman:

    1. Configurar la URL y el método:
      • URL: https://gna.bpo.lat/api.php
      • Método: POST
    2. Configurar los headers:
      • Key: Authorization
      • Value: Bearer HGKUJFJSHJDKRUJG7J3854J98DJEUHFJSJGKRJ76843UJFISMF9WJGHT7J693EEW
    3. Configurar los parámetros en el cuerpo (Body):
      • Seleccionar form-data
      • Añadir los parámetros:
        • init_value: 9
        • end_value: 99
    4. Enviar la solicitud y verificar la respuesta.

    Ejemplo PHP

    										
          $token = 'HGKUJFJSHJDKRUJG7J3854J98DJEUHFJSJGKRJ76843UJFISMF9WJGHT7J693EEW';
          $fields = array(
              "init_value" => 0, "end_value" => 99
          );
    
          $url = "https://gna.bpo.lat/api.php";
    
          $ch = curl_init($url);
    
          curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($fields));
          curl_setopt($ch, CURLOPT_HTTPHEADER, array('Authorization: Bearer '.$token,'Accept: application/json'));
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    
          $response = curl_exec($ch);
          $response = json_decode($response);
          //Cierra la conexión cURL
          curl_close($ch);
    
          $data = array('GNA' => "OK", 'Result' => $response->gna);
    
          echo json_encode($data, JSON_UNESCAPED_UNICODE);
                            				
    									

    Respuesta

    
    {
        "GNA": "OK",
        "Result": "{"GNA":33}"
    }

    Manejo de errores

    Código Mensaje Description
    0 Método inválido, de envío de datos Quiere decir que no se están enviando los datos por POST
    1 Header: 'Authorization' no encontrado Quiere decir que la cabecera Authorization no se está enviando correctamente.
    2 Tipo de token inválido Quiere decir que no se está enviando el token autorizado en el método "Bearer"
    3 Valores enviados no son número enteros Quiere decir que los parámetros enviados no son número enteros.
    4 Acceso no autorizado Quiere decir que el token que se usó para acceder a la API no coincide con un token autorizado.