Questions? Feedback? powered by Olark live chat software

Support and Documentation


Important!
This documentation has been deprecated. We are migrating Oempro help articles to our new help portal. Take a look at more detailed help articles on our new help portal.

Sections:

  1. What is API?
  2. Benefits
  3. Examples
  4. API Reference
    1. Administrators
    2. Attachments
    3. Auto Responders
    4. Campaigns
    5. Clients
    6. Custom Fields
    7. Email
    8. List Integration
    9. Lists
    10. Media Library
    11. Segments
    12. Subscribers
    13. Settings
    14. Tags
    15. Users
    16. User Interface Themes
    17. User Groups

    API Reference

    What is API?

    API allows developers to integrate different softwares easily. Oempro includes full-featured API. You can access to API function of almost every functionality that you can see on the Oempro user interface.

    Oempro's API allows you to connect and integrate via HTTP POST and GET methods.

    To give you an example, you can integrate your website shopping cart with Oempro easily. For every new customer, you can call Oempro's subscription API command and subscribe the new customer email address to a subscriber list and let Oempro to send your customer a series of post-purchase auto responders.

    Oempro API gives you endless capabilities and opportunities.

    Benefits

    We tried to list a few benefits that you will have with Oempro's API capabilities:

    • Full-featured API commands
    • Integrate with any third party desktop or web based application
    • Expand Oempro's capabilities and feature sets
    • Simple API communication
    • Ability to receive response data in JSON or XML format

    Examples

    Sending Request To Oempro API

    Oempro API can accept data in HTTP POST or HTTP GET method. Below, we provided an HTTP GET example that logs you into user area:

    http://yourdomain.com/oempro/api.php?Command=User.Login&ResponseFormat=XML&
    Username=admin&Password=admin 
    

    API Response

    Once you execute the above API call, you will receive either a success data or error data:

    On error:

    <?xml version="1.0" encoding="utf-8"?>
    <response>
        <Success></Success>
        <ErrorCode/>
        <ErrorText/>
    </response>
    

    On success:

    <?xml version="1.0" encoding="utf-8"?>
    <response>
        <Success><![CDATA[1]]></Success>
        <ErrorCode><![CDATA[0]]></ErrorCode>
        <ErrorText></ErrorText>
        <SessionID><![CDATA[08be000c325a0cc466d85032bf9c9573]]></SessionID>
        <UserInfo>
            <UserID><![CDATA[1]]></UserID>
            <RelUserGroupID><![CDATA[1]]></RelUserGroupID>
            <EmailAddress><![CDATA[test@domain.com]]></EmailAddress>
            <Username><![CDATA[admin]]></Username>
            <Password><![CDATA[21232f297a57a5a743894a0e4a801fc3]]></Password>
        </UserInfo>
    </response>
    

    API Reference

    Administrators

    Attachments

    Auto Responders

    Campaigns

    Clients

    Custom Fields

    Email

    List Integration

    Lists

    Media Library

    Segments

    Subscribers

    Settings

    Tags

    Users

    User Interface Themes

    User Groups

    Stay connected!