0% found this document useful (0 votes)
2 views

Ecinetwireless backend code3

To integrate with Econet's XML-RPC API, you need to obtain API credentials, the API endpoint URL, provider code, product codes, account types, exchange rate information, updated API documentation, test environment access, IP whitelisting, legal agreements, and support contact information. These items are essential for authentication, configuration, and secure communication with Econet's systems. After gathering these requirements, you can set up a test environment before going live with the integration.

Uploaded by

emeliamakore
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as TXT, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
2 views

Ecinetwireless backend code3

To integrate with Econet's XML-RPC API, you need to obtain API credentials, the API endpoint URL, provider code, product codes, account types, exchange rate information, updated API documentation, test environment access, IP whitelisting, legal agreements, and support contact information. These items are essential for authentication, configuration, and secure communication with Econet's systems. After gathering these requirements, you can set up a test environment before going live with the integration.

Uploaded by

emeliamakore
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as TXT, PDF, TXT or read online on Scribd
You are on page 1/ 3

Yes, to integrate with Econet's XML-RPC API, there are several things you **must

obtain from Econet** before you can successfully use the API in your code. These
are essential for authentication, configuration, and ensuring that your application
can communicate with Econet's systems securely and effectively.

Here’s a checklist of what you need from Econet:

---

### 1. **API Credentials**


- **Username and Password**: These are required for authentication when making
API calls. You will use these credentials in every request to the Econet API.
- Example: `ECONET_USERNAME` and `ECONET_PASSWORD` in your code.
- **How to Obtain**: Contact Econet's technical support or API team to request
API credentials. They will provide you with a username and password.

---

### 2. **API Endpoint URL**


- **API URL**: The base URL for the Econet XML-RPC API. This is the endpoint
where you will send all your requests.
- Example: `https://api.econet.co.zw/xmlrpc` (this is just an example; you
need the actual URL from Econet).
- **How to Obtain**: Econet will provide you with the correct API endpoint URL.
Ensure that it is the production URL and not a test/staging URL unless you are in a
testing phase.

---

### 3. **Provider Code**


- **Provider Code**: This is a numeric code that identifies Econet as the mobile
network operator. In the API documentation, Econet's provider code is listed as
**200**.
- Example: `ProviderCode: 200` in your requests.
- **How to Obtain**: This is usually provided in the API documentation or by
Econet's technical team. Confirm the correct provider code with them.

---

### 4. **Product Codes (for Bundles)**


- **Product Codes**: If you are using the `load_bundle` API, you need to know
the specific product codes for the data bundles you want to purchase.
- Example: `ProductCode: "DDB50"` (this is just an example; you need the
actual codes from Econet).
- **How to Obtain**: Econet will provide you with a list of valid product codes
for their data bundles. These codes are specific to Econet's system.

---

### 5. **Account Types**


- **Account Types**: For certain operations (e.g., `load_bundle`), you need to
specify the account type (e.g., IN account or Wallet account).
- Example: `AccountType: 0` for IN account or `AccountType: 1` for Wallet
account.
- **How to Obtain**: Confirm with Econet which account types are supported and
what their corresponding codes are.

---
### 6. **Exchange Rate Information**
- **Exchange Rate**: If you are dealing with multiple currencies, Econet may
provide exchange rate information in the API response (e.g., for `load_value`).
- Example: The `Rate` field in the response.
- **How to Obtain**: This is typically handled by the API itself, but you should
confirm with Econet how exchange rates are managed and whether you need to handle
any currency conversions.

---

### 7. **API Documentation**


- **Updated API Documentation**: Ensure you have the latest version of the API
documentation from Econet. This will include:
- All available API methods (e.g., `load_value`, `load_bundle`,
`deduct_value`, etc.).
- Required and optional parameters for each method.
- Response formats and status codes.
- **How to Obtain**: Request the latest API documentation from Econet's
technical team.

---

### 8. **Test Environment**


- **Test Credentials and Endpoint**: Before going live, you should test your
integration in a sandbox or test environment provided by Econet.
- Example: A test API URL, test username, and test password.
- **How to Obtain**: Request access to Econet's test environment from their
technical team.

---

### 9. **IP Whitelisting**


- **Whitelisted IP Addresses**: Econet may require you to provide the IP
addresses of your servers that will be making API requests. They will whitelist
these IPs to ensure only authorized systems can access their API.
- **How to Obtain**: Provide Econet with the public IP addresses of your
servers.

---

### 10. **Legal and Compliance Requirements**


- **API Usage Agreement**: Econet may require you to sign an agreement or terms
of service before granting access to their API.
- **How to Obtain**: Contact Econet's business or legal team to complete any
necessary paperwork.

---

### 11. **Support Contact**


- **Technical Support Contact**: Obtain the contact information for Econet's
technical support team in case you encounter issues during integration.
- **How to Obtain**: Request this information from Econet when setting up your
API access.

---

### Summary of What You Need from Econet:


| **Item** | **Description**
| **Example** |
|-------------------------|--------------------------------------------------------
-------------------------|---------------------------------|
| API Credentials | Username and password for authentication
| `ECONET_USERNAME`, `ECONET_PASSWORD` |
| API Endpoint URL | The base URL for the Econet XML-RPC API
| `https://api.econet.co.zw/xmlrpc` |
| Provider Code | Numeric code identifying Econet as the mobile network
operator | `ProviderCode: 200` |
| Product Codes | Codes for data bundles (if using `load_bundle`)
| `ProductCode: "DDB50"` |
| Account Types | Codes for account types (e.g., IN account, Wallet
account) | `AccountType: 0` |
| Exchange Rate Info | How exchange rates are handled (if dealing with
multiple currencies) | `Rate: 15.787812` |
| API Documentation | Latest version of the API documentation
| Provided by Econet |
| Test Environment | Test credentials and endpoint for sandbox testing
| Provided by Econet |
| IP Whitelisting | Whitelisted IP addresses for your servers
| Provided by you to Econet |
| Legal Agreement | Signed API usage agreement or terms of service
| Provided by Econet |
| Support Contact | Contact information for Econet's technical support team
| Provided by Econet |

---

### Next Steps:


1. **Contact Econet**: Reach out to Econet's technical or business team to request
the items listed above.
2. **Set Up Test Environment**: Use the test credentials and endpoint to ensure
your integration works as expected before going live.
3. **Go Live**: Once testing is complete, switch to the production environment
using the production credentials and endpoint.

By obtaining these items from Econet, you will have everything you need to
successfully integrate their API into your application.

You might also like