{"id":2928,"date":"2023-08-30T11:53:35","date_gmt":"2023-08-30T11:53:35","guid":{"rendered":"https:\/\/sallythings.co.za\/help\/?post_type=kbx_knowledgebase&p=2928"},"modified":"2023-08-30T11:56:00","modified_gmt":"2023-08-30T11:56:00","slug":"secure-api","status":"publish","type":"kbx_knowledgebase","link":"https:\/\/sallythings.co.za\/help\/sally-help\/secure-api\/","title":{"rendered":"Secure API"},"content":{"rendered":"

How Do I Use Secure API?<\/strong><\/p>\n

Go to Flyout Menu >\u00a0Integrations<\/strong>.<\/p>\n

\"https:\/\/d33v4339jhl8k0.cloudfront.net\/docs\/assets\/5c7ef84204286350d088abbb\/images\/63e295e4d2459a27d10c8deb\/file-Y3k3sfjPuk.png\"<\/p>\n

At the top of the page select\u00a0Secure API.<\/strong><\/p>\n

\"https:\/\/d33v4339jhl8k0.cloudfront.net\/docs\/assets\/5c7ef84204286350d088abbb\/images\/63e297968ae59c3643e33ee4\/file-b5LiEuiQ30.png\"<\/p>\n

This page provides you will all available\u00a0Authentication Information<\/strong>.<\/p>\n

Live Documentation:<\/strong>\u00a0This is a completely white-labeled document that can be accessed by anyone without needing to be logged in. It provides instructions on how to connect and allows you to test your API connection<\/p>\n

\u00a0to access this Live API Document<\/em><\/p>\n

API Limits:\u00a0<\/strong>There are limits to the number of API calls your account can make. These\u00a0limits are based on the Plan you are on. These requests will be tracked in your account so you can see how many you have left at any given time.<\/p>\n

Free Trial\u00a0<\/strong>= 80 calls\/month \u00a0 | \u00a0\u00a0Start<\/strong>\u00a0= 400 calls\/month\u00a0 | \u00a0\u00a0Thrive<\/strong>\u00a0= 2,000 calls\/month\u00a0 | \u00a0\u00a0Pinnacle<\/strong>\u00a0= 20,000 calls\/month<\/p>\n

API Authorization Credentials:<\/strong>\u00a0Here you can access your\u00a0Public ID\u00a0<\/strong>and\u00a0Secret Key<\/strong>(s).<\/p>\n

Click\u00a0+ Add Secret Key<\/strong>\u00a0to add a new Secret Key. Give it a name and click Save for it to be added to the list.<\/p>\n

\"https:\/\/d33v4339jhl8k0.cloudfront.net\/docs\/assets\/5c7ef84204286350d088abbb\/images\/63e29af5d4571976c49de866\/file-my2gyLYsV3.png\"<\/p>\n

You can\u00a0copy<\/strong>\u00a0your keys or\u00a0delete<\/strong>\u00a0them by clicking the appropriate icon.<\/p>\n

\"https:\/\/d33v4339jhl8k0.cloudfront.net\/docs\/assets\/5c7ef84204286350d088abbb\/images\/63e29c83d2459a27d10c8df2\/file-dS56XQMzIv.png\"<\/p>\n

Who Can Access Secure API?<\/strong><\/p>\n

Only Super Admins and Admins will have access to Secure API. To limit this to just the Super Admin role go to\u00a0Flyout Menu<\/strong>\u00a0>\u00a0Platform Branding<\/strong>.\u00a0Scroll down to the section titled\u00a0White Label Visibility<\/strong>.<\/p>\n

When enabled the Admin role will no longer be able to view Secure API from the Integrations menu.<\/p>\n

\u00a0to read more about\u00a0Platform Branding<\/em><\/p>\n

How Do I Use the Live Documentation?<\/strong><\/p>\n

First, you will need to authenticate your account using the API credentials provided to you in\u00a0Integrations<\/strong>\u00a0>\u00a0Secure API<\/strong>.<\/p>\n

Simply click the green “Authorize” button and paste\/authorize your Public ID and one of the Secret Keys you created inside your account. After you have successfully authorized, you will be able to extract a complete schema of Meta Attributes.<\/p>\n

\"https:\/\/d33v4339jhl8k0.cloudfront.net\/docs\/assets\/5c7ef84204286350d088abbb\/images\/63e3f14bd2459a27d10c8ff0\/file-QMAS1zls97.png\"<\/p>\n

After you have authorized the LIVE Interactive Documentation, the next step will be to extract a full schema of the Custom Data that is unique to your account. For this, you can use the GET \/contact\/meta endpoint. Simply toggle open the GET \/contact\/meta accordion and look for the “Try it out” button on the right side. Click that button, and then click the “Execute” button.<\/p>\n

The Secure API Response will include a complete schema of all the CRM Company and CRM Contact Custom Fields that exist in your account, along with all the Meta Attributes you or your developer will need to properly configure an API integration.<\/p>\n

\"https:\/\/d33v4339jhl8k0.cloudfront.net\/docs\/assets\/5c7ef84204286350d088abbb\/images\/64631d06c6234261f380e028\/file-etvDTvuagn.png\"<\/p>\n

At the bottom right of this Response window, you’ll find that you can Download the entire response as a JSON file, and this can be used for easy reference or passed to your developer.<\/p>\n

Once you have the complete schema for the CRM Company or CRM Contact data, you can use the GET, POST, and PUSH endpoints to\u00a0build a complete 2-way data sync.<\/p>\n

\"https:\/\/d33v4339jhl8k0.cloudfront.net\/docs\/assets\/5c7ef84204286350d088abbb\/images\/63e3f1a6f19b3c454741d87e\/file-NRmlj0LdDY.png\"<\/p>\n

HOW DO I TEST IT?<\/em><\/strong><\/p>\n

After you have authorized the LIVE Interactive Documentation, you are able to perform LIVE tests directly from here.<\/p>\n

Inside each Endpoint toggle, you will find a “Try it out” button which will open a data field. Inside that field, you are able to configure API calls that will connect to the Secure API Endpoint and make LIVE changes to the database. You will see these changes immediately reflected in your account, so before using this, be sure you understand the full ramifications of each call you execute.<\/p>\n

In order to have a better perspective on the responses without using real credentials, certain types of requests were built to be able to use test credentials that will return random dummy responses. Dummy-type credentials can only be used for requests where the text ”\u00a0* dummy request allowed<\/em>” appears in the description. The test credentials are:<\/p>\n

X-Public-ID:\u00a000000000-0000-0000-0000-000000000000<\/p>\n

X-Secret-Key:\u00a0DummySecretKey<\/p>\n

\"https:\/\/d33v4339jhl8k0.cloudfront.net\/docs\/assets\/5c7ef84204286350d088abbb\/images\/63e3f1daf19b3c454741d87f\/file-tqmiorIYD0.png\"<\/p>\n","protected":false},"excerpt":{"rendered":"

How Do I Use Secure API? Go to Flyout Menu >\u00a0Integrations. At the top of the page select\u00a0Secure API. This page provides you will all available\u00a0Authentication Information. Live Documentation:\u00a0This is a completely white-labeled document that can be accessed by anyone without needing to be logged in. It provides instructions on how to connect and allows […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"comment_status":"open","ping_status":"closed","template":"","kbx_category":[30,40],"kbx_tag":[],"class_list":["post-2928","kbx_knowledgebase","type-kbx_knowledgebase","status-publish","hentry","kbx_category-integration","kbx_category-default-section"],"_links":{"self":[{"href":"https:\/\/sallythings.co.za\/help\/wp-json\/wp\/v2\/kbx_knowledgebase\/2928","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/sallythings.co.za\/help\/wp-json\/wp\/v2\/kbx_knowledgebase"}],"about":[{"href":"https:\/\/sallythings.co.za\/help\/wp-json\/wp\/v2\/types\/kbx_knowledgebase"}],"author":[{"embeddable":true,"href":"https:\/\/sallythings.co.za\/help\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/sallythings.co.za\/help\/wp-json\/wp\/v2\/comments?post=2928"}],"version-history":[{"count":1,"href":"https:\/\/sallythings.co.za\/help\/wp-json\/wp\/v2\/kbx_knowledgebase\/2928\/revisions"}],"predecessor-version":[{"id":2937,"href":"https:\/\/sallythings.co.za\/help\/wp-json\/wp\/v2\/kbx_knowledgebase\/2928\/revisions\/2937"}],"wp:attachment":[{"href":"https:\/\/sallythings.co.za\/help\/wp-json\/wp\/v2\/media?parent=2928"}],"wp:term":[{"taxonomy":"kbx_category","embeddable":true,"href":"https:\/\/sallythings.co.za\/help\/wp-json\/wp\/v2\/kbx_category?post=2928"},{"taxonomy":"kbx_tag","embeddable":true,"href":"https:\/\/sallythings.co.za\/help\/wp-json\/wp\/v2\/kbx_tag?post=2928"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}