Integration Partner Onboarding

Integration Partner Onboarding

Integration Partner Onboarding

CustomBooks™ is a platform that accountants trust.

At CustomBooks™, our mission is to simplify Accounting and Inventory Management for businesses, but we understand every business is unique. This page describes how we empower our Integration Partners with development tools and our scalable platform to solve these unique needs.

Sign Up as an Integration Partner

  1. Open the developer portal's Signup page.
  2. Provide your basic SignUp information to Get Started.
  3. Click Send Verification Code button to verify your identity. If your company uses Google Workspace email service, you can verify using your Google account.
  4. We recommend that you book an Appointment with our Strategic Partner Manager by clicking the Book A Meeting button. This will help speedup the on-boarding process.
  5. Click Continue To Set Password to play with our Playground and get familiar with CustomBooks™. 
  6. Play with some of our most popular plans and Explore API.
  7. Update your Profile details. This includes setting up MFA (recommended) using Google Authenticator, uploading your profile image, and other company information. 

Engage with our Strategic Partner Manager

A Strategic Partner Manager will walk you through the rest of the on-boarding process to make sure you take full advantage of CustomBooks™'s features and tools.

The Strategic Partner Manager will:
  1. Setup a Walk-through with CustomBooks™ playground accounts.
  2. Connect you with an CustomBooks™ IT contact for next development steps and any Q&A.
  3. Share the information such as the Brand Assets, Guidelines and Best Practices for using CustomBooks™ Integration tools.
  4. Approve your developer account after a successful Walk-through. Approved Integration Partners will get exclusive access to our new features, new APIs and co-marketing campaigns/webinars.
  5. Be sure to keep your team engaged with the CustomBooks™ IT team while you develop your solution.

Create Your First App

You will need to create an App to generate keys for the integration. You can do this by clicking on My Apps on the menu and clicking on Create New App button.

CustomBooks™ IT Contact can help you answer questions (if any) related to the form field values. 
After the App is successfully created, you can open the App form My Apps page.
You will have following information available to manage the new App:
  1. App Profile: This tab displays the App information and the Application logo. If the Application logo is not available, Application Name is visible to the user during access authorization.
  2. Keys: This tab contains the Client ID and Client Secret for security and authorization. This tab also has the Signature Secret Key to ensure that messages are indeed from CustomBooks™.
  3. Redirect URLs: This tab contains the Redirect URLs. When authorizing user access, you will need to send one of the redirect URLs listed on this tab. 
  4. Webhook URLs: This tab will list the Webhooks setup for the Application. 
  5. Stats: This tab will show the Connect and Disconnect event stats for your Live App. 
NOTE: Remember to edit your App's status to Live by editing the App, and do not forget to upload your App's logo.

Test your App

We provide testing tools to help you test the end-to-end process for your apps. Select Test Apps from the menu to get started with testing. As a prerequisite, you will need access to an account in CustomBooks™. Please work with the Strategic Partner Manager if you do not already have access to a test tenant.
  1. Select your App from the list. You will see the credentials the test will use for your App. Click Next.
  2. You can use Test Redirect URL so that the application redirects to the Integration Partner portal after the authorization step. You can also select one of your Redirect URLs for the App if you'd like for it to redirect to your endpoint. 
  3. Click on Connect to CustomBooks™ button. This is sourced from our Brand Assets page. This will initiate the Authorization process and provide you with an Authorization code. 
  4. Click on Get Access Token. This will give you the AccessToken you will use to connect with your CustomBooks™ Client's account to access the client's data. 
  5. Click on Make API Call. This will run a sample API call to make sure the Access Token generated is able to access the data resources from the account authorized.
  6. Last Step is to test the Disconnect from CustomBooks™ button. This will remove the access to the authorized account.

Disconnect your App feature

We provide a way for you (developer's application portal) and the CustomBooks™ authorized user to disconnect the connection to your application. 

Disconnect from Developer's Application Portal

1. When a user connects your App to CustomBooks™ successfully, we recommend that you show a Disconnect button. Please refer to the Brand Asset Guidelines for the button images and guidelines.
2. When user clicks the Disconnect button on the developer’s application, use following service call:
  1. POST https://oauth.custombooks.com/disconnect-application
    {
          ‘access_token’    : 'Replace With Access Token',
          ‘client_id’      : 'Replace With ClientID',
          ‘client_secret’    : 'Replace With ClientSecret'
    }
3. You can look at the disconnect application events on the "Stats" tab for the Live App on the CustomBooks™’s developer portal.

Disconnect from CustomBooks™

Active CustomBooks™ users (Roles: Subscription Owner or Administrator only) have permissions to disconnect the application from the CustomBooks™’s User Interface.
After a successful login to the CustomBooks™ application, the user can go to "Admin Panel" --> "Beta Preview" --> "Manage connected applications" menu, and click  the "Disconnect" button for the application. 
​
To connect to the App again, the user will need to initiate the connection from developer’s application portal.

    • Related Articles

    • Getting Started with Cloud Payroll - Onboarding

      Cloud Payroll Onboarding Overview Welcome to the CustomBook™'s Cloud Payroll module! Our seamless onboarding wizard will walk you through setting up and managing payroll for your company. Our onboarding wizard will allow you to monitor your progress ...

    • Paypal Integration

      With the Paypal Integration you can make payments or take receipts from your Paypal account from within the software. Setting up Paypal Integration in Settings Setup In order to integrate Paypal with CustomBooks™️ you must first have a Paypal ...

    • Setting up the Shipstation Integration

      ShipStation centralizes your shipping and the integration with CustomBooks™ makes the process seamless. Shipping package information is entered on the Shipment document and pre-paid labels can be printed directly from CustomBooks™. Shipstation also ...

    • Printing Shipping Label using the ShipStation Integration

      Printing Shipping Labels for a Shipment On the Sales Order, ensure the Use Shipments checkbox is checked. From the Generate button, choose Shipment. Click the Shipping Tab. Choose a Carrier from the list. Enter values for Ship From, Shipping Date and ...

    • AccountingSuite™ Release Updates, German Shepherd 7, Paya Integration

      AccountingSuite™ Release Updates, German Shepherd 7 Announcing the AccountingSuite™ and Paya Integration! Paya delivers a complete payment system to you and your clients. Through Paya’s payment platform businesses can: Email invoices to customers for ...