API · SDK
Configurar clientes de API y SDK
Mantén las URL base fuera del código, haz que apunten al servicio real y añade una comprobación que impida que las direcciones de ejemplo lleguen a producción.
Guía · Documentación
La documentación, los tutoriales y las pruebas necesitan direcciones, números y nombres que parezcan reales pero que nunca lleguen a nadie. Para la mayoría de los tipos de valor existe un rango reservado. Esta guía los reúne, cada uno con su fuente, para que los ejemplos sigan siendo inofensivos cuando alguien los copia.
Los ejemplos se copian: en código, archivos de configuración, pruebas y otra documentación. Un valor que parece inventado pero pertenece a alguien envía ese tráfico, esos correos o esas llamadas a un tercero real. example-petstore.com es un buen ejemplo: un nombre inventado en la documentación de Google que cualquiera podía registrar y que todavía recibe solicitudes. Los valores reservados tienen la garantía de que nunca se asignarán, así que un ejemplo copiado falla sin causar daño.
Para sitios web, API y direcciones de correo en ejemplos, usa example.com, example.net o example.org y sus subdominios, como api.example.com y user@example.com. Para entornos de prueba, nombres que nunca deben resolverse y redes locales existen .test, .invalid, .localhost, home.arpa y .internal.
Para qué sirve cada nombre reservado y por qué imitaciones como example-petstore.com no son seguras: Dominios de ejemplo
| Tipo | Reservado para documentación | Fuente |
|---|---|---|
| IPv4 | 192.0.2.0/24 (TEST-NET-1), 198.51.100.0/24 (TEST-NET-2), 203.0.113.0/24 (TEST-NET-3) | RFC 5737 |
| IPv6 | 2001:db8::/32 | RFC 3849 |
| IPv6, redes más grandes | 3fff::/20 | RFC 9637 (2024) |
# Un cliente, un servidor y un proxy en un ejemplo
client 192.0.2.10 2001:db8::10
server 198.51.100.20 2001:db8:1::20
proxy 203.0.113.30 2001:db8:2::30
Los tres bloques IPv4 dan a un ejemplo tres “redes” separadas, lo que ayuda a explicar el enrutamiento o los
cortafuegos. 3fff::/20 existe porque 2001:db8::/32 es demasiado pequeño para mostrar
asignaciones realistas de grandes proveedores.
Para ejemplos de BGP: 64496–64511 (16 bits) y 65536–65551 (32 bits),
reservados para documentación por el RFC 5398. Los números AS de uso privado están pensados para redes reales, no para
ejemplos.
De 00-00-5E-00-53-00 a 00-00-5E-00-53-FF (escritas como 00:00:5e:00:53:00 en la
mayoría de las herramientas) están reservadas para documentación por el RFC 9542 (que sustituyó al RFC 7042).
No existe un rango mundial; varios países reservan el suyo para la ficción y los ejemplos:
555-0100 a 555-0199, con cualquier prefijo de
zona, como +1 202 555 0143.07700 900000 a 07700 900999, Londres de
020 7946 0000 a 020 7946 0999, y de 01632 960000 a 01632 960999 sin
una zona concreta.Para otros países, consulta al regulador de telecomunicaciones. Si no hay ningún rango, usa un número ficticio que no se pueda
marcar, como +31 6 XXXX XXXX, en lugar de cifras que solo parecen aleatorias.
Los proveedores de pago publican números de tarjeta de prueba que solo funcionan en su modo de prueba, como el
4242 4242 4242 4242 de Stripe, con cualquier fecha de caducidad futura y cualquier CVC. Usa los números del
proveedor que estés integrando; otro proveedor no acepta sus números de prueba. No uses nunca un número de
tarjeta real, ni siquiera el tuyo, en documentación, fixtures o capturas de pantalla.
10.0.0.0/8 o 192.168.0.0/16 en
documentación pública: existen en la propia red del lector, así que un ejemplo copiado puede llegar allí a un dispositivo
real.YOUR_API_KEY o
sk_test_…, nunca una clave que haya sido válida alguna vez.