Guía de Uso de la API de Integración de Pagos

Esta guía detalla los pasos necesarios para trabajar con la API de integración de pagos, comenzando con la creación de una compañía.

Paso 1: Obtener el Secret Key

El primer paso es obtener el SecretKey que se genera a partir de la suscripción a la API PridesPayment en Azure API Manager.

Suscripción a la API PridesPayment en Azure API Manager

Una vez suscrita, se obtiene el SecretKey tambien conocido como PrimaryKey de su perfil


Perfil de la suscripción a la API PridesPayment en Azure API Manager

Paso 2: Crear una Compañía

Para crear una nueva compañía, utiliza el endpoint de creación de compañías con una solicitud POST. Asegúrate de incluir el SecretKey válido en tu solicitud.

Endpoint:

POST /api/v1/Company/Create
Host: your-api-host
Content-Type: application/json

{
    "Name": "NombreDeLaCompañía",
    "Description": "Descripción de la Compañía",
    "PrimaryKey": "tu_secret_key"
}
        

Ejemplo de Código en C#

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

namespace ApiIntegrationExample
{
    class Program
    {
        private static readonly string ApiUrl = "https://your-api-host/api/v1/Company/Create";
        private static readonly string SecretKey = "tu_secret_key";

        static async Task Main(string[] args)
        {
            var company = new
            {
                Name = "NombreDeLaCompañía",
                Description = "Descripción de la Compañía",
                SecretKey = "SecretKey"
            };

            var json = Newtonsoft.Json.JsonConvert.SerializeObject(company);
            var data = new StringContent(json, Encoding.UTF8, "application/json");

            using var client = new HttpClient();
            var response = await client.PostAsync(ApiUrl, data);

            string result = response.Content.ReadAsStringAsync().Result;
            Console.WriteLine(result);
        }
    }
}
        

Validar el SecretKey

Antes de crear una compañía, es importante validar el SecretKey. Para ello, puedes usar el siguiente endpoint:

GET /api/v1/Auth/ValidarSecret/secretKey?SecretKey={your_secret_key}
Host: your-api-host
        

Paso 3: Crear una Orden

Después de crear la compañía, puedes proceder a crear una orden utilizando el endpoint correspondiente.

Endpoint:

POST /api/v1/Order/CreateOrder
Host: your-api-host
Content-Type: application/json

{
    "customer": "03-0351-0477",
    "amount": 1000.00,
    "externalTransactionId": "342402332432",
    "phoneNumber": "80183300"
}