E-Arabization API Documentation

Overview

E-Arabization (earabization.ae) offers a platform-independent system to manage content translation through secured API webhooks. It integrates with the Phrase platform to enable automatic translation workflows, reducing manual workload for businesses managing multilingual content.

You will be provided a security_token for your project, which developers use to create translation requests with our provided APIs.

Authentication

All API requests require an HMAC SHA-256 signature included in the X-Signature header. This signature is computed using the project's security_token and the request payload.

Example Headers

• Content-Type: application/json
• X-Signature: HMAC_SHA256(payload, security_token)

1. POST /api/webhook/project-request/create

Creates a new translation request for a specific entity (e.g., product, page).

Request Headers

• Content-Type: application/json
• X-Signature: HMAC SHA-256

Request Payload Example

{
  "security_token": "your_token",
  "entity_type": "product",
  "entity_identifier": "4315324124",
  "callback_url": null,
  "language_code": "en",
  "data": {
    "title": "New Product",
    "description": "Description text",
    "price": 99.99
  }
}

Behavior

• Creates the project request in the system.
• The data to be translated will be inside the data parameter (must be valid JSON).
• If automatic translation is enabled, triggers the Phrase translation pipeline.
• The callback_url will automatically return translation data when approved (must accept POST requests).

Success Response (201 Created)

JSON with message and created project request details.

2. POST /api/webhook/project-request/get

Retrieves the approved translation data for a given entity and language, if available.

Request Headers

• Content-Type: application/json
• X-Signature: HMAC SHA-256

Request Payload Example

{
  "security_token": "your_token",
  "entity_type": "product",
  "entity_identifier": "4315324124",
  "language_code": "zh"
}

Success Response (200 OK)

{
  "message": "Approved translation retrieved.",
  "translation": {
    "title": "translated title",
    "description": "translated description",
    "price": "99.99"
  }
}

Error Response (404 Not Found)

Message indicating no approved translation is available.

Additional Notes

• All payloads must be valid JSON.
• The system supports multiple entity types (product, page, etc.).
• For security, ensure your security_token is kept confidential.
• Use proper error handling on the client side to handle 4xx/5xx responses.