Olá. Recentemente estive estudando a plataforma para iniciar as integrações com a API e me deparei com situações corriqueiras que estão muito sujeitas a erros comuns o que acaba dificultando a vida do usuário final.
Abaixo segue um código que peguei como base na documentação de integração para Criação de planos.
Deixar no formato de string para que nós possamos incluir os dados, fica muito suscetível a errar e acaba dificultando bastante o formato de implementação.
public async Task RegistrarCobranca() {
var plano = new Plano(Guid.NewGuid()); // Fake Data
var respostaCriaPlano = await Client.PlansController.CreatePlanAsync(new() {
Name = plano.Nome,
Description = plano.Descricao,
BillingType = "", // Enumerador pro tipo de cobrança
PaymentMethods = new() {
"" // Enumerador para Tipo de pagamento já que são tipos conhecidos
},
Currency = "", // Aqui também vale um Enumerador para o tipo de moeda que será transitada
});
}
Sugestão
Ao invés de deixar no formato livre, adicionem Enumeradores para cada modalidade.
Forma de Pagamento (PaymentMethods)
Na forma de pagamento, é bem típico e existem poucas formas de pagamento, incluam enumeradores que correspondam aos tipos de pagamento que a plataforma é capaz de processar, assim o leque de escolhas ficará mais claro.
Tipo da moeda (Currency)
A moeda que será usada, também pode ser incluída em um enumerador para BRL, USD, USDT e etc. Isso dará menos chance de incluirmos os formatos errados e termos problemas na integração.
Tipo de cobrança (BillingType)
Este é um dos itens que realmente deve ser enumerado, isso vai ajudar bastante até mesmo pra agilizar o lado de quem está criando a integração.
Estes foram alguns exemplos que pude trazer, provavelmente existe muitos outros itens que podem ser transformados em enumeradores e até mesmo transformado em objetos próprios pra deixar a API mais robusta e fácil de usar :)
Problema
Olá. Recentemente estive estudando a plataforma para iniciar as integrações com a API e me deparei com situações corriqueiras que estão muito sujeitas a erros comuns o que acaba dificultando a vida do usuário final.
Abaixo segue um código que peguei como base na documentação de integração para Criação de planos. Deixar no formato de string para que nós possamos incluir os dados, fica muito suscetível a errar e acaba dificultando bastante o formato de implementação.
Sugestão
Ao invés de deixar no formato livre, adicionem Enumeradores para cada modalidade.
Forma de Pagamento (PaymentMethods) Na forma de pagamento, é bem típico e existem poucas formas de pagamento, incluam enumeradores que correspondam aos tipos de pagamento que a plataforma é capaz de processar, assim o leque de escolhas ficará mais claro.
Tipo da moeda (Currency) A moeda que será usada, também pode ser incluída em um enumerador para BRL, USD, USDT e etc. Isso dará menos chance de incluirmos os formatos errados e termos problemas na integração.
Tipo de cobrança (BillingType) Este é um dos itens que realmente deve ser enumerado, isso vai ajudar bastante até mesmo pra agilizar o lado de quem está criando a integração.
Estes foram alguns exemplos que pude trazer, provavelmente existe muitos outros itens que podem ser transformados em enumeradores e até mesmo transformado em objetos próprios pra deixar a API mais robusta e fácil de usar :)
Desde já agradeço a atenção. Desde já, agradeço.