{"id":280,"date":"2023-02-02T15:41:07","date_gmt":"2023-02-02T15:41:07","guid":{"rendered":"https:\/\/devdocs.resales-online.com\/index.php\/docs\/api-to-create-webapi-keys\/documentation\/"},"modified":"2023-02-17T12:24:33","modified_gmt":"2023-02-17T12:24:33","slug":"documentation","status":"publish","type":"docs","link":"https:\/\/devdocs.resales-online.com\/index.php\/docs\/api-to-create-webapi-keys\/documentation\/","title":{"rendered":"Documentation"},"content":{"rendered":"\n

Full documentation for developers.<\/p>\n\n\n\n

<\/div>\n\n\n\n

Configuration<\/h2>\n\n\n\n

End point<\/h3>\n\n\n\n

Production: https:\/\/8kdxv7r3ke.execute-api.eu-central-1.amazonaws.com\/prod\/createapikey<\/p>\n\n\n\n

Development: https:\/\/s7xv5kenvf.execute-api.ap-southeast-1.amazonaws.com\/dev\/createapikey<\/p>\n\n\n\n

Token<\/h3>\n\n\n\n

For this API to work you must have a Token. Request one to our IT team.<\/p>\n\n\n\n

<\/div>\n\n\n\n

Formatting the request<\/h2>\n\n\n\n

The request must include the authentication and requested data on the body content.
Must be on Json format and only by POST method.<\/p>\n\n\n\n

Authentication<\/h3>\n\n\n\n

The authentication should be done including the header \u201cAuthorization:\u201d with the \u201cBearer token\u201d.<\/p>\n\n\n\n

\n        curl_setopt($ch, CURLOPT_HTTPHEADER, array(\n            'Accept:application\/json',\n            'Content-Type:application\/json',\n            'Authorization:Bearer 073ljkaoiufa98793lkja90d87a9sduf3leujeYA'\n        ));\n<\/code><\/pre>\n\n\n\n
Data<\/h3>\n\n\n\n
The body request must be in Json format with the following needed data:<\/p>\n\n\n\n
    \n
  • UserName<\/li>\n\n\n\n
  • serverIp<\/li>\n\n\n\n
  • source<\/li>\n\n\n\n
  • webDeveloperEmail (optional)<\/li>\n<\/ul>\n\n\n\n
    \n  {\n    \"userName\": \"agentname@demo\",\n    \"serverIP\": \"15.79.40.86\",\n    \"source\": \"Your company\",\n    \"webDeveloperEmail\": \"webdeveloper@mydomain.com\"\n  }\n<\/code><\/pre>\n\n\n\n
    <\/p>\n\n\n\n
    <\/div>\n\n\n\n
    Flow<\/h2>\n\n\n\n
    Pre-requisites<\/h3>\n\n\n\n
    The Resales-Online userName is unique per user.
    The user belongs to a Real Estate Agency.
    The user is an active Account Administrator.
    Each Real Estate Agency ONLY can have one API key per IP.<\/p>\n\n\n\n
    Processing<\/h3>\n\n\n\n
      \n
    1. Validation of the Authorization Bearer<\/li>\n\n\n\n
    2. Check if all required body data is included<\/li>\n\n\n\n
    3. Validation of UserName. If exists and is an active RSO user<\/li>\n\n\n\n
    4. Check if there is an existing API key for the given IP and the Agency linked to that username<\/li>\n\n\n\n
    5. Create Web API key on Version 6.\n
        \n
      1. Create 4 predefined filters<\/li>\n<\/ol>\n<\/li>\n\n\n\n
      2. Send Web API data on response<\/li>\n<\/ol>\n\n\n\n
        <\/p>\n\n\n\n
        <\/div>\n\n\n\n
        Output<\/h2>\n\n\n\n
        The output will contain the request status: error or success
        <\/p>\n\n\n\n
        If error. A description of the error will be given. E.g.:<\/p>\n\n\n\n
        \n  {\n    \"status\": \"error\",\n    \"error\": {\n        \"number\": 401,\n        \"description\": \"Not valid authentication token\"\n    },\n    \"data\": {\n        \"request_datetime\": \"2022-11-24 09:11:52\"\n    }\n  }\n<\/code><\/pre>\n\n\n\n
        If success. The Web API data will be returned. E.g.: <\/p>\n\n\n\n
        \n   {\n    \"status\": \"success\",\n    \"error\": {},\n    \"data\": {\n        \"P1\": \"9858974\",\n        \"P2\": \"a8813b46eccb1dsqed0036fbbd1e5a9027fdc563\",\n        \"ServerIP\": \"15.179.49.86\",\n        \"APIVersion\": \"API V6\",\n        \"AgencyName\": \"DEMO AGENCY\",\n        \"request_datetime\": \"2022-11-23 13:11:27\"\n    }\n   }\n<\/code><\/pre>\n\n\n\n
        <\/p>\n\n\n\n
        Troubleshooting <\/h3>\n\n\n\n
        Response code<\/th>Error number<\/th>Error description<\/th>Reason<\/th>Solution<\/th><\/tr><\/thead>
        401<\/td>401<\/td>Not valid authentication token<\/td>The header “Authentication Bearer” is missing or not valid.<\/td>Review your request headers and verify includes the correct token<\/td><\/tr>
        400<\/td>101<\/td>(xx) is mandatory.<\/td>Mandatory data is missing.<\/td>Verify all mandatory parameters are included on the body request in a JSON format.<\/td><\/tr>
        400<\/td>102<\/td>(xx) is not a valid IP address.<\/td>The parsed IP is not well formed.<\/td>Verify the parsed serverIP is correct.<\/td><\/tr>
        400<\/td>103<\/td>UserName does not exist<\/td>The parsed UserName is not a valid RSO user.<\/td>Confirm the userName with the Real Estate Agent<\/td><\/tr>
        400<\/td>104<\/td>The given UserName is not an active account administrator.<\/td>The parsed UserName is not valid. Because must be an Admin User.<\/td>Confirm with the Real Estate Agency if the given userName is an Admin user.<\/td><\/tr>
        200<\/td>110<\/td>There is an existing API key for the server IP: xx.xx.xx.xx<\/td>The Real Estate Agency have already an API key for the parset serverIP<\/td>Ask RSO IT support.<\/td><\/tr>
        500\/501<\/td>501<\/td>Server error<\/td><\/td>Ask RSO IT support.<\/td><\/tr><\/tbody><\/table><\/figure>\n","protected":false},"featured_media":0,"parent":243,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","doc_tag":[],"class_list":["post-280","docs","type-docs","status-publish","hentry"],"comment_count":0,"_links":{"self":[{"href":"https:\/\/devdocs.resales-online.com\/index.php\/wp-json\/wp\/v2\/docs\/280","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devdocs.resales-online.com\/index.php\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/devdocs.resales-online.com\/index.php\/wp-json\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/devdocs.resales-online.com\/index.php\/wp-json\/wp\/v2\/comments?post=280"}],"version-history":[{"count":5,"href":"https:\/\/devdocs.resales-online.com\/index.php\/wp-json\/wp\/v2\/docs\/280\/revisions"}],"predecessor-version":[{"id":312,"href":"https:\/\/devdocs.resales-online.com\/index.php\/wp-json\/wp\/v2\/docs\/280\/revisions\/312"}],"up":[{"embeddable":true,"href":"https:\/\/devdocs.resales-online.com\/index.php\/wp-json\/wp\/v2\/docs\/243"}],"next":[{"title":"Version History","link":"https:\/\/devdocs.resales-online.com\/index.php\/docs\/api-to-create-webapi-keys\/version-history\/","href":"https:\/\/devdocs.resales-online.com\/index.php\/wp-json\/wp\/v2\/docs\/279"}],"wp:attachment":[{"href":"https:\/\/devdocs.resales-online.com\/index.php\/wp-json\/wp\/v2\/media?parent=280"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/devdocs.resales-online.com\/index.php\/wp-json\/wp\/v2\/doc_tag?post=280"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}