/MsGraph_OneNoteApiSamplePHP

Primary LanguagePHPApache License 2.0Apache-2.0

Microsoft Graph OneNote API PHP Sample README

Created by Microsoft Corporation, 2017. Provided As-is without warranty. Trademarks mentioned here are the property of their owners.

API functionality demonstrated in this sample

The following aspects of the API are covered in this sample. You can find additional documentation at the links below.

* Indicates documentation for multi-part POST requests to the OneNote API before its integration into the Microsoft Graph API. The documentation for the outlined request examples work as of the production of this sample, but be aware that changes may be upcoming.

Prerequisites

Tools and Libraries you will need to download, install, and configure for your development environment.

The PHP sample runs on a web server. The client browser needs to be able to access the web server to complete the handshake. Make sure that you install the PHP files so that:

  • The web server you're using is accessible from the Internet
  • The web server has PHP installed, with the cURL package enabled
  • You have a normal URL with hostname (not just an IP address) to use for the Redirect URL. If you run this from your own desktop, you'll need to modify your Hosts file (in C:\Windows\System32\drivers\etc for Windows machines and /private/etc for Macs) and map your local server IP address to a new domain name, as in the following example. Modify your Hosts file and map your local server IP address to a new domain name

Accounts

  • As the developer, you'll need to have a Microsoft account and get a client ID string so your app can authenticate with the Microsoft Azure AD v2.0 endpoint.
  • As the user of the sample, you'll need a Microsoft account (Azure AD/Org ID or an MSA account) so the OneNote API can send the pages to your OneDrive.

Register the sample

After you've setup your web server described above,....

  1. Clone the Git repository to a folder on your local machine.
  2. Go to the Microsoft app registration page.
  3. It is highly recommended that you get your own client ID, secret and redirect URI. You can get your own client ID, client secret and redirect URI. here
  4. For local development, the sample uses http://localhost:8888/callback.php as a redirect URI. For production, you should change this to point to your application's domain on your hosted deployment. If the root deployment URL is https://onenoteapisamples.com, then specify https://onenoteapisamples.com/callback.php as the Redirect URL (as in the following example). This URL must exactly match the deployed redirect URL. The root domain name must be unique, so if you use one domain for testing and another for production, you'll need to register separate client ids and secrets for each domain.Specify API settings in the Microsoft Application Registration Portal

Note: Chrome and Firefox do not allow cookies to be set on localhost, and thus authentication will not work on these browsers during development if you choose to redirect to localhost.

Set up the sample

  1. Replace the following placeholders in the callback.php and index.php files with the associated values from the App Settings page:
    1. Replace CLIENT_ID with the client ID value.
    2. Replace CLIENT_SECRET with the client secret value.
    3. Replace REDIRECT_URI_PATH with the value of the deployment root URL. The deployment root URL consists of "http://" plus the root domain URL, so if your redirect URL looks like http://onenoteapisamples.com/callback.php, the deployment root URL is "http://onenoteapisamples.com." At run time, the redirect URL value will resolve to "http://onenoteapisamples.com/callback.php."
  2. Put the sample files in the root directory on your web server.
  3. Open a browser and navigate to the default .php page.
  4. Login using your Microsoft account, and allow the app to create pages in your OneNote notebooks.

Version info

Version info

Date Change
May 2017 Updated to utilize the Microsoft Graph v1.0 base URL for OneNote resources
April 2017 Updated to utilize the Microsoft Graph API endpoints.
May 2014 Initial public release for this code sample.

Known issues

  • If you're running the sample on a web server on a home network, and you don't have a fixed IP address and assigned domain name, you may need to use a DDNS provider, and then forward the HTTP/S ports to your local server.
  • The PHP files in this sample contain CRLF line endings. You'll need to retain these line endings when you open and edit these files in your editor. See Dealing with line endings for guidance on how to retain CRLF line endings on all platforms.

Learning more

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.