├── LICENSE.md ├── README.md └── src ├── api.py ├── api_example.py ├── oauth.py └── web_utils.py /LICENSE.md: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | bullhorn-api-example-python 2 | =========================== 3 | This a sample Python application that demonstrates a very simple usage of the Bullhorn REST API from a Web application. 4 | 5 | The biggest initial hurdle for developers is typically getting OAuth authentication working properly, so much 6 | of this sample is dedicated to that. 7 | 8 | You will need an OAuth partner key and secret to run the sample app successfully. 9 | 10 | This sample uses a small Python Web framework, [web.py](http://webpy.org/) to spin up a Web application 11 | in order to demonstrate the full OAuth redirect, authenticate, redirect flow. 12 | 13 | There are four source files: 14 | 1. api.py - Utility functions for logging in to the REST API and making calls to it 15 | 2. oauth.py - Utility functions for making OAuth authentication calls 16 | 3. web_utils.py - A few general Web utility functions 17 | 4. api_example.py - The main sample app code. Spins up and configures the Web app, and 18 | implements request handlers for OAuth and sample API calls. 19 | -------------------------------------------------------------------------------- /src/api.py: -------------------------------------------------------------------------------- 1 | from web_utils import * 2 | 3 | base_url = 'https://rest.bullhornstaffing.com/rest-services' 4 | rest_token_param = "BhRestToken" 5 | rest_url_param = "restUrl" 6 | 7 | class ApiLogin: 8 | def __init__(self, rest_url, rest_token): 9 | self.rest_url = rest_url 10 | self.rest_token = rest_token 11 | 12 | def login(access_code): 13 | """ 14 | Logs in to the REST API given an OAuth access token. Returns a dictionary 15 | containing the data returned by the login call. This includes: 16 | - The API endpoint URL 17 | - An authentication token 18 | Subsequent calls to the API must use the endpoint URL as their base URL, 19 | and must send the authentication token as a request parameter called 'BhRestToken' 20 | """ 21 | login_data = json_http_call(base_url + '/login?version=*&access_token=' + access_code) 22 | return ApiLogin(login_data[rest_url_param], login_data[rest_token_param]) 23 | 24 | def make_call(endpoint, token, command, method='GET', params=None): 25 | if params is None: 26 | params = { } 27 | params[rest_token_param] = token 28 | 29 | http_params = build_querystring(params) 30 | 31 | if method == 'GET': 32 | return json_http_call("%s%s?%s" % (endpoint, command, http_params)) 33 | else: 34 | return json_http_call("%s%s" % (endpoint, command), http_params) 35 | -------------------------------------------------------------------------------- /src/api_example.py: -------------------------------------------------------------------------------- 1 | import web, json, urllib 2 | import oauth, api 3 | from web_utils import * 4 | 5 | app_base_path = '/sample' 6 | oauth_redirect_path = app_base_path + '/oauth-callback' 7 | 8 | urls = ( 9 | app_base_path, 'userid', 10 | oauth_redirect_path, 'auth', 11 | app_base_path + '/logout', 'reset' 12 | ) 13 | 14 | """ 15 | Set up a web.py application with session data stored on disk. 16 | """ 17 | app = web.application(urls, globals()) 18 | if web.config.get('_session') is None: 19 | session = web.session.Session(app, web.session.DiskStore('sessions'), 20 | initializer={'count': 0, 'access_token': None, 'rest_token': None, 'rest_url': None}) 21 | web.config._session = session 22 | else: 23 | session = web.config._session 24 | 25 | 26 | def oauth_redirect_uri(): 27 | return web.ctx.home + oauth_redirect_path 28 | 29 | def auth_check(): 30 | if session.rest_token is None: 31 | raise web.seeother(oauth.build_authorize_url(web.ctx.path, oauth_redirect_uri())) 32 | 33 | def api_call(command, method='GET', params=None): 34 | return api.make_call(session.rest_url, session.rest_token, command, method, params) 35 | 36 | 37 | class auth: 38 | """ 39 | This is the OAuth authentication callback. 40 | 41 | Once the user enters credentials on the Bullhorn OAuth 42 | login page, his/her browser will be redirected here, with 43 | a "code" query parameter added, containing an authorization 44 | code. 45 | 46 | This code will then negotiate an access token with Bullhorn 47 | OAuth given an authorization token on the query string. 48 | It will then use that access token to obtain a REST API token. 49 | 50 | The URL of this call is what you must give to Bullhorn as your 51 | OAuth callback URI. 52 | """ 53 | def GET(self): 54 | # parse the query string into a dictionary 55 | params = parseQuery(web.ctx.query) 56 | if session.access_token is None: 57 | if 'code' in params: 58 | session.access_token = oauth.get_access_token(params['code'], oauth_redirect_uri()) 59 | else: 60 | web.ctx.status = "400" 61 | return "oauth authorization code missing from parameters" 62 | 63 | api_login_data = api.login(session.access_token) 64 | session.rest_url = api_login_data.rest_url 65 | session.rest_token = api_login_data.rest_token 66 | 67 | if 'state' in params: 68 | redirect = urllib.unquote(params['state']) 69 | else: 70 | redirect = app_base_path 71 | raise web.seeother(redirect) 72 | 73 | class userid: 74 | """ 75 | Our sample API call. Simply gets the logged-in user's 76 | user ID using the /settings call. 77 | """ 78 | def GET(self): 79 | auth_check() 80 | data = api_call("settings/userId") 81 | return "your user ID is: %s" % data["userId"] 82 | 83 | class reset: 84 | """ 85 | Clears the session. 86 | """ 87 | def GET(self): 88 | session.kill() 89 | return "session reset" 90 | 91 | if __name__ == "__main__": 92 | app.run() 93 | -------------------------------------------------------------------------------- /src/oauth.py: -------------------------------------------------------------------------------- 1 | from web_utils import * 2 | 3 | # Bullhorn OAuth client ID 4 | client_id = "CLIENT_ID_HERE" 5 | 6 | # Bullhorn OAuth secret 7 | client_secret = 'CLIENT_SECRET_HERE' 8 | 9 | # Bullhorn OAuth service endpoint 10 | base_url = 'https://auth.bullhornstaffing.com/oauth' 11 | 12 | def get_access_token(code, redirect_url): 13 | """ 14 | Gets an OAuth access token given an OAuth authorization code 15 | """ 16 | access_token_params = build_querystring({ 17 | 'grant_type': 'authorization_code', 18 | 'client_id': client_id, 19 | 'client_secret': client_secret, 20 | 'redirect_uri': redirect_url, 21 | 'code': code 22 | }) 23 | 24 | access_token_response = json_http_call(base_url + '/token', access_token_params) 25 | print("=====> " + str(access_token_response)) 26 | return access_token_response["access_token"] 27 | 28 | def build_authorize_url(state, redirect_url): 29 | qstr = build_querystring({ 30 | "client_id": client_id, 31 | "response_type": "code", 32 | "redirect_uri": redirect_url, 33 | "state": state 34 | }) 35 | 36 | return base_url + "/authorize?" + qstr 37 | -------------------------------------------------------------------------------- /src/web_utils.py: -------------------------------------------------------------------------------- 1 | import urllib2, json 2 | 3 | def parseQuery(q): 4 | after_qmark = q[1:] 5 | if (len(after_qmark) < 2): 6 | return { } 7 | return dict([p.split("=") for p in q[1:].split("&")]) 8 | 9 | def build_querystring(d): 10 | return '&'.join(['%s=%s' % (str(k), str(v)) for k, v in d.items()]) 11 | 12 | def json_http_call(url, data=None): 13 | try: 14 | if data is None: 15 | res = urllib2.urlopen(url) 16 | else: 17 | res = urllib2.urlopen(url, data) 18 | data = res.read() 19 | except urllib2.HTTPError, e: 20 | data = e.read() 21 | print "error in request: " + url + ": " + data 22 | 23 | return json.loads(data) 24 | 25 | --------------------------------------------------------------------------------