API basics
The Archefusion API is a RESTful, JSON-based API that uses standard HTTP methods and requires authentication for all requests. All requests must be made over HTTPS.Base URL
The base URL for all endpoints ishttps://dev.api-gateway.archefusion.com. This works for both test and live environments. Your API key determines which environment you are in.
Environment and API keys
Archefusion offers two completely isolated environments: Test and Live. Each of these environments has its own set of keys.| Key type | Prefix |
|---|---|
| Test API key | af_test_ |
| Test webhook secret | af_whsec_test_ |
| Live API key | af_live_ |
| Live webhook secret | af_whsec_live_ |
See authentication for details on obtaining and managing your API keys.
Content-Type
All requests must include aContent-Type header set to application/json. Requests and response bodies are formatted as JSON.
HTTP methods
Archefusion uses standard HTTP verbs for different actions.| Method | Description |
|---|---|
| GET | Retrieves data |
| POST | Creates new resources |
HTTP response codes
Archefusion returns standard HTTP response codes to indicate the outcome of each request.| HTTP code | Description |
|---|---|
| 200 | The request was processed successfully. However, this doesn’t mean the intended action was successful. You should check the data.status field to confirm the outcome. |
| 201 | A new resource was created successfully. |
| 400 | The request was not processed. This occurs when query or body parameters are invalid or a required field is missing. |
| 401 | The request was not authorized. This occurs when the provided API key is invalid or missing. |
| 404 | The requested resource does not exist. |
| 500 | An error occurred on Archefusion’s servers. If you encounter this error, contact [email protected]. |
Next step
Learn how to authenticate API requests and manage your API keys.