@tucupy-tecnologia/cielo-ecommerce-sdk-unofficial
Version:
SDK Não Oficial para interagir com a API Cielo E-commerce usando Bun/Node.js
39 lines (38 loc) • 1.42 kB
TypeScript
/**
* Define os ambientes disponíveis para a API Cielo.
*/
export declare enum Environment {
/** Ambiente de Sandbox para Transações/Pagamentos. */
SANDBOX_TRANSACTION = "https://apisandbox.cieloecommerce.cielo.com.br",
/** Ambiente de Sandbox para Consultas (BIN, etc.). */
SANDBOX_QUERY = "https://apiquerysandbox.cieloecommerce.cielo.com.br",
/** Ambiente de Produção para Transações/Pagamentos. */
PRODUCTION_TRANSACTION = "https://api.cieloecommerce.cielo.com.br",
/** Ambiente de Produção para Consultas (BIN, etc.). */
PRODUCTION_QUERY = "https://apiquery.cieloecommerce.cielo.com.br"
}
export type CieloEnvironment = 'SANDBOX' | 'PRODUCTION';
/**
* Interface para as configurações necessárias para inicializar o SDK.
*/
export interface CieloConfig {
/**
* Identificador da loja na Cielo (Merchant ID).
* Obtido durante o credenciamento.
*/
merchantId: string;
/**
* Chave da loja na Cielo (Merchant Key).
* Obtida durante o credenciamento.
*/
merchantKey: string;
/**
* O ambiente onde as requisições serão feitas (Sandbox ou Produção).
*/
environment: CieloEnvironment;
/**
* Opcional: Uma função para gerar IDs de requisição únicos.
* Útil para idempotência e rastreamento. Se não fornecido, usa crypto.randomUUID().
*/
requestIdGenerator?: () => string;
}