Below are instructions on how your developer can integrate a third party system/software to communicate with our software. One example of a possible use is to have it so that once a member joins or pays at a third party site their account is automatically created within your membership site.
URL To Send Request To:
your-domain.com/admin/emailcontactapi.php
Variables (POST/GET):
| Field | Required | Version | Description |
| apikey | Yes | 4.1 | The API Key found on the "Advanced Features" page in your software's members area. The API Key is used to authenticate the request. |
| Yes | 4.1 | The email address of the contact being retrieved. | |
| ausername | No* | 4.1 | The username of the member that this contact belongs to. If neither ausername, aid, nor aemail is provided then an error will be thrown. |
| aid | No* | 4.1 | The id of the member that this contact belongs to. If neither ausername, aid, nor aemail is provided then an error will be thrown. |
| aemail | No* | 4.1 | The email of the member that this contact belongs to. If neither ausername, aid, nor aemail is provided then an error will be thrown. |
| subject | Yes | 4.1 | Title of the email that is being sent |
| message | Yes | 4.1 | Content of the email that is being sent |
URL To Send Request To:
your-domain.com/api/sms.php
Variables (POST/GET):
| Field | Required | Version | Description |
| apikey | Yes | 4.1 | The API Key found on the "Advanced Features" page in your software's members area. The API Key is used to authenticate the request. |
| username | No* | 4.1 | The username of the member that the credits should be added to. If neither username, affid, nor email is provided then an error will be thrown. |
| No* | 4.3 | The email of the member that the credits should be added to. If neither username, affid, nor email is provided then an error will be thrown. | |
| affid | No* | 4.3 | The id of the member that the credits should be added to. If neither username, affid, nor email is provided then an error will be thrown. |
| credits | Yes | 4.1 | The amount of sms credits to add to the members account. |
URL To Send Request To:
your-domain.com/admin/formtemplatesapi.php
Variables (POST/GET):
| Field | Required | Version | Description |
| apikey | Yes | 4.21 | The API Key found on the "Advanced Features" page in your software's members area. The API Key is used to authenticate the request. |
| user | No* | 4.21 | Either user OR affid OR email is required. The username of the member that the form should belong to. |
| affid | No* | 4.21 | Either user OR affid OR email is required. The id of the member that the form should belong to. |
| No* | 4.21 | Either user OR affid OR email is required. The email of the member that the form should belong to. | |
| action | Yes | 4.21 |
| Action = 1 Get Available Form Templates (no additional fields required) | |||
| Action = 2 Get Custom Fields For A Specific Form Template | |||
| Field | Required | Version | Description |
| templateid | Yes | 4.2 | The id of the form template from which the custom fields should be retrieved. |
| Action = 3 Get HTML Code For A Specific Form Template | |||
| Field | Required | Version | Description |
| templateid | Yes | 4.2 | The id of the form template from which the html code should be retrieved. |
| ftc# | No | 4.2 | # is the id of the custom form field returned in action 2. If this is provided then it uses the value provided for the custom form field. Otherwise it uses the default value specified for the custom form field. |
| group | No | 4.2 | The contact group that the contact should be assigned to after filling out the form. If not provided the default value is: 1 |
| redirect | No | 4.2 | The url that a contact should be redirected to after filling out the form. If not provided uses the value set under advanced features, or if that is blank, uses the value set under my personal info for the member. |
| campaign | No | 4.2 | The campaign that the contact should be assigned to after filling out the form. |
URL To Send Request To:
your-domain.com/admin/membernotifyemailapi.php
Variables (POST/GET):
| Field | Required | Version | Description |
| apikey | Yes | 4.22 | The API Key found on the "Advanced Features" page in your software's members area. The API Key is used to authenticate the request. |
| user | No* | 4.22 | Either user OR affid OR email is required. The username of the member that the form should belong to. |
| affid | No* | 4.22 | Either user OR affid OR email is required. The id of the member that the form should belong to. |
| No* | 4.22 | Either user OR affid OR email is required. The email of the member that the form should belong to. | |
| mneid | Yes | 4.22 | The id of the member notification email to send |
URL To Send Request To:
your-domain.com/admin/adcoopapi.php
Variables (POST/GET):
| Field | Required | Version | Description |
| apikey | Yes | 4.22 | The API Key found on the "Advanced Features" page in your software's members area. The API Key is used to authenticate the request. |
| user | No* | 4.22 | Either user OR affid OR email is required. The username of the member that the form should belong to. |
| affid | No* | 4.22 | Either user OR affid OR email is required. The id of the member that the form should belong to. |
| No* | 4.22 | Either user OR affid OR email is required. The email of the member that the form should belong to. | |
| acid | Yes | 4.22 | The id of the ad coop to apply shares to |
| qty | Yes | 4.22 | The quantity of shares to be added |
| expire | No | 4.22 | The amount of days after today that the shares should expire. If not provided uses the amount of days specified for the ad coop |
