Universally tiene dos API, y cuál necesita depende de lo que esté construyendo. Una traduce contenido, la otra administra su cuenta. Ambas están documentadas con ejemplos de solicitudes en vivo en developer.universally.com.
Las dos API
| API de Traductor | API de Plataforma | |
|---|---|---|
| Anfitrión | translator.universally.com |
api.universally.com |
| Referencia | Abrir la especificación | Abrir la especificación |
| Para | convertir contenido a otro idioma | administrar proyectos, idiomas, glosarios y traducciones almacenadas |
| Clave | la clave API privada del proyecto | una clave API de espacio de trabajo |
| Usado por | el plugin de WordPress, y su propia integración | scripts y herramientas alrededor del panel de control |
Si está reemplazando el plugin de WordPress en otra plataforma, la API de Traductor es la que necesita. La API de Plataforma es para automatizar el panel de control, no para servir páginas.
Primero, cree un proyecto
Un proyecto es lo que contiene su dominio, su idioma de origen, sus idiomas de destino y sus claves, por lo que viene antes de cualquier llamada a la API. Dos maneras de crear uno.
En el panel de control. Abra Nuevo Proyecto. Seleccione su tecnología actualmente solo ofrece WordPress: las otras opciones tienen una insignia Próximamente y no se pueden seleccionar. Eso está bien para una integración de API, ya que la tecnología solo cambia lo que le muestra el panel de control, no lo que acepta la API de Traductor. Una consecuencia a esperar: la pantalla Configuración de API del proyecto seguirá informando "Plugin de Universally no detectado", porque para un proyecto de WordPress busca el plugin en su dominio. Nada está mal y la traducción funciona independientemente.
Con la API de Plataforma. POST /sites crea un proyecto con una clave de espacio de trabajo pak_, y toma name, domain, sourceLanguage y tech. Use tech: "wordpress" para un sitio con un dominio, o tech: "app" cuando no hay dominio que proporcionar. tech: "website" y el modo de subdominio están en beta cerrada y se rechazan por ahora. No envíe un workspaceId: se toma de la clave.
curl -X POST https://api.universally.com/sites \
-H "X-API-Key: $UNIVERSALLY_PLATFORM_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"Docs site","domain":"example.com","sourceLanguage":"en-us","tech":"wordpress"}'
Luego agregue idiomas de destino, ya sea en la pantalla Todos los idiomas del proyecto o a través de la API de Plataforma, y copie la clave del proyecto desde Configuración de API.
La API de Traductor
Tres puntos finales, todos POST, todos autenticados con la clave privada del proyecto en una cabecera X-API-Key:
| Endpoint | Envíelo |
|---|---|
/v1/traducir/html |
una página renderizada, cuando pueda entregar HTML completo |
/v1/traducir/cadenas |
un arreglo de cadenas, cuando usted mismo retiene el contenido |
/v1/traducir |
uno u otro, y decide cuál de los anteriores aplica |
El endpoint de HTML es la coincidencia más cercana a cómo funciona el plugin: su servidor envía la página que estaba a punto de devolver, y sirve lo que recibe. Nada necesita saber de antemano qué texto hay en la página. Vea Descripción general de la API REST para las formas de solicitud y respuesta, y Errores y límites de la API para lo que puede esperar cuando se alcanza un límite de palabras a mitad de la solicitud.
curl -X POST https://translator.universally.com/v1/translate/html \
-H "X-API-Key: $UNIVERSALLY_KEY" \
-H "Content-Type: application/json" \
-d '{"html":"<html>...</html>","targetLanguage":"es","sourceUrl":"https://example.com/pricing/"}'
La API de Plataforma
Misma cabecera, clave diferente: una clave API de espacio de trabajo, que comienza con pak_. Llega a los mismos endpoints que usa el panel, por lo que puede agregar idiomas, editar reglas de glosario, leer traducciones almacenadas y listar sitios sin que nadie haga clic en la interfaz de usuario.
Cree uno en Espacios de trabajo, luego en Claves API. Vea Encuentre su clave API.
Lo que aún tiene que construir
El plugin hace más que llamar a un endpoint, y nada de eso es gratuito a través de la API:
- Servir URLs de idiomas. Algo tiene que enrutar
/es/pricing/a su respuesta en español. Universally traduce lo que envía; no se interpone delante de su sitio. - Caché. Traduzca una vez y almacene el resultado. Volver a enviar la misma página no gasta palabras de nuevo, ya que una cadena solo se cobra la primera vez que se ve, pero cada solicitud cuesta un viaje de ida y vuelta y la latencia que conlleva.
- Detectar cambios. Vuelva a enviar una página cuando su contenido cambie, de lo contrario, los visitantes seguirán viendo la traducción antigua.
- El selector de idiomas. El plugin incluye uno. A través de la API, el marcado es suyo. Vea Crear un selector de idiomas personalizado en WordPress para su forma.