Skip to content

Commit c264f57

Browse files
committed
docs: mention api key requirement
1 parent 021e2fc commit c264f57

2 files changed

Lines changed: 54 additions & 0 deletions

File tree

README.es.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ SDK oficial de Java para [Facturapi](https://www.facturapi.io).
44

55
English: [README.md](README.md)
66

7+
Facturapi ayuda a generar facturas electrónicas válidas en México (CFDI).
8+
9+
Si alguna vez has usado Stripe o algún SDK similar de pagos o facturación, la interfaz aquí te resultará familiar: modelos tipados en las respuestas y JSON flexible en las entradas.
10+
11+
Asegúrate de tener una cuenta de Facturapi y tu API Key a la mano.
12+
713
[![CI](https://img.shields.io/github/actions/workflow/status/facturapi/facturapi-java/ci.yml?branch=main&style=for-the-badge&label=CI)](https://github.com/facturapi/facturapi-java/actions/workflows/ci.yml)
814
[![Maven Central](https://img.shields.io/maven-central/v/io.facturapi/facturapi-java?style=for-the-badge&label=Maven%20Central)](https://central.sonatype.com/artifact/io.facturapi/facturapi-java)
915
[![Java](https://img.shields.io/badge/Java-11%2B-ED8B00?style=for-the-badge&logo=openjdk&logoColor=white)](https://openjdk.org/)
@@ -104,3 +110,24 @@ Facturapi facturapi = Facturapi.builder("sk_test_...")
104110
.timeout(java.time.Duration.ofSeconds(20))
105111
.build();
106112
```
113+
114+
### Cliente HTTP personalizado
115+
116+
Para pruebas o configuraciones avanzadas, puedes inyectar tu propio `OkHttpClient`:
117+
118+
```java
119+
import okhttp3.OkHttpClient;
120+
121+
Facturapi facturapi = Facturapi.builder("sk_test_...")
122+
.httpClient(new OkHttpClient())
123+
.build();
124+
```
125+
126+
## Documentación
127+
128+
Docs completas: [https://docs.facturapi.io](https://docs.facturapi.io)
129+
130+
## Soporte
131+
132+
- Issues: abre un issue en GitHub
133+
- Email: `contacto@facturapi.io`

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ Official Java SDK for [Facturapi](https://www.facturapi.io).
44

55
Español: [README.es.md](README.es.md)
66

7+
Facturapi helps developers generate valid electronic invoices (CFDI) in Mexico.
8+
9+
If you've used Stripe or a similar API-first payments or billing SDK, the surface here should feel familiar: typed models on the way out, flexible JSON objects on the way in.
10+
11+
Make sure you have a Facturapi account and your API key.
12+
713
[![CI](https://img.shields.io/github/actions/workflow/status/facturapi/facturapi-java/ci.yml?branch=main&style=for-the-badge&label=CI)](https://github.com/facturapi/facturapi-java/actions/workflows/ci.yml)
814
[![Maven Central](https://img.shields.io/maven-central/v/io.facturapi/facturapi-java?style=for-the-badge&label=Maven%20Central)](https://central.sonatype.com/artifact/io.facturapi/facturapi-java)
915
[![Java](https://img.shields.io/badge/Java-11%2B-ED8B00?style=for-the-badge&logo=openjdk&logoColor=white)](https://openjdk.org/)
@@ -104,3 +110,24 @@ Facturapi facturapi = Facturapi.builder("sk_test_...")
104110
.timeout(java.time.Duration.ofSeconds(20))
105111
.build();
106112
```
113+
114+
### Custom HTTP Client
115+
116+
For tests or advanced setups, you can inject your own `OkHttpClient`:
117+
118+
```java
119+
import okhttp3.OkHttpClient;
120+
121+
Facturapi facturapi = Facturapi.builder("sk_test_...")
122+
.httpClient(new OkHttpClient())
123+
.build();
124+
```
125+
126+
## Documentation
127+
128+
Full docs: [https://docs.facturapi.io](https://docs.facturapi.io)
129+
130+
## Support
131+
132+
- Issues: open a GitHub issue
133+
- Email: `contacto@facturapi.io`

0 commit comments

Comments
 (0)