diff --git a/README-Localized/Readme-es-es.md b/README-Localized/Readme-es-es.md new file mode 100644 index 0000000..644e50f --- /dev/null +++ b/README-Localized/Readme-es-es.md @@ -0,0 +1,82 @@ +Ejemplo Léame de PHP de la API de OneNote en Microsoft Graph +--------------------------------------------- + +Creado por Microsoft Corporation, 2017. Se proporciona tal cual sin garantía. Las marcas comerciales que se mencionan aquí pertenecen a sus propietarios. + +### La funcionalidad de la API que se muestra en este ejemplo + +En este ejemplo, se tratan los siguientes aspectos de la API. Puede encontrar documentación adicional en los siguientes vínculos. + +- [Iniciar sesión de usuario](https://developer.microsoft.com/es-es/graph/docs/authorization/app_authorization) +- [Obtener las páginas de OneNote de un usuario](https://developer.microsoft.com/es-es/graph/docs/api-reference/beta/api/page_get) +- [Publicar una página HTML simple en una nueva página de notas rápidas de OneNote](https://developer.microsoft.com/es-es/graph/docs/api-reference/beta/api/notes_post_pages) +- [Publicar mensaje de varias partes con datos de imagen incluidos en la solicitud*](http://msdn.microsoft.com/es-es/library/office/dn575432.aspx) +- [Publicar página con una URL representada como una imagen*](http://msdn.microsoft.com/es-es/library/office/dn575431.aspx) +- [Publicar página con HTML representado como una imagen*](http://msdn.microsoft.com/es-es/library/office/dn575432.aspx) +- [Publicar página con un archivo PDF representado y adjunto*](http://msdn.microsoft.com/es-es/library/office/dn655137.aspx) + +\* Indica la documentación de las solicitudes de publicación de varias partes a la API de OneNote antes de su integración en la API de Microsoft Graph. La documentación de los ejemplos de solicitud detallados funciona a partir de la producción de este ejemplo, pero tenga en cuenta que pueden producirse cambios. + +### Requisitos previos + +**Herramientas y bibliotecas** que tendrá que descargar, instalar y configurar en el entorno de desarrollo. + +El ejemplo de PHP se ejecuta en un servidor web. El navegador del cliente debe poder acceder al servidor web para completar el protocolo de enlace. Asegúrese de instalar los archivos PHP para que: + +- El servidor web que está usando sea accesible desde Internet +- El servidor web tenga PHP instalado, con el paquete cURL activado +- Tenga una dirección URL normal con un nombre de host (no solo una dirección IP) para usar para la URL de redireccionamiento. Si lo ejecuta desde su propio escritorio, tendrá que modificar el archivo de hosts (en C:\\Windows\\System32\\drivers\\etc para equipos Windows y /private/etc para Mac) y asignar la dirección IP del servidor local a un nuevo nombre de dominio, como en el ejemplo siguiente. ![Modificar el archivo de hosts y asignar la dirección IP del servidor local a un nuevo nombre de dominio](images/HostsFile.png) + +**Cuentas** + +- Como desarrollador, necesitará [tener una cuenta de Microsoft y obtener una cadena de Id. de cliente](http://msdn.microsoft.com/es-es/library/office/dn575426.aspx) para que su aplicación pueda autenticarse con el punto de conexión de Microsoft Azure AD v2.0. +- Como usuario del ejemplo, necesitará una cuenta de Microsoft (Azure AD/Id. org. o una cuenta MSA) para que la API de OneNote pueda enviar las páginas a OneDrive. + +### Registrar el ejemplo + +Después de configurar su servidor web descrito anteriormente,.... + +1. Clone el repositorio de Git en una carpeta del equipo local. +2. Vaya a la [página de registro de aplicaciones de Microsoft](https://account.live.com/developers/applications/index). +3. Es altamente recomendado que obtenga su propio Id. de cliente, secreto de cliente y URI de redireccionamiento. Puede obtener su propio Id. de cliente, secreto de cliente y URI de redireccionamiento. [Aquí](http://developer.microsoft.com/es-es/graph/docs/authorization/auth_register_app_v2) +4. Para el desarrollo local, el ejemplo usa http://localhost:8888/callback.php como URI de redireccionamiento. Para producción, debe cambiar esta para indicar el dominio de la aplicación en la implementación hospedada. Si la dirección URL de implementación raíz es https://onenoteapisamples.com, especifique https://onenoteapisamples.com/callback.php como la URL de redireccionamiento (como en el ejemplo siguiente). Esta dirección URL debe coincidir exactamente con la URL de redireccionamiento implementado. El nombre de dominio raíz tiene que ser único, por lo que si usa un dominio para pruebas y otro para producción, tendrá que registrar los Id. de cliente y secretos de cliente separados para cada dominio.[Especificar la configuración de API en el Portal de registro de aplicaciones de Microsoft](images/OneNoteMSAScreen.png) +>Nota: Chrome y Firefox no permiten establecer cookies en localhost y, por lo tanto, la autenticación no funcionará en estos navegadores durante el desarrollo si decide redirigir a localhost. + +### Configurar el ejemplo + +1. Reemplace los siguientes marcadores de posición en los archivos callback.php e index.php con los valores asociados de la página Configuración de la aplicación: + 1. Reemplace CLIENT\_ID por el valor de Id. de cliente. + 2. Reemplace CLIENT\_SECRET por el valor de secreto de cliente. + 3. Reemplace REDIRECT\_URI\_PATH por el valor de la dirección URL raíz de la implementación. La dirección URL raíz de la implementación consiste en "http://" más la URL del dominio raíz, por lo que si la URL de redireccionamiento es como http://onenoteapisamples.com/callback.php, la dirección URL raíz de la implementación es "http://onenoteapisamples.com". En tiempo de ejecución, el valor URL de redireccionamiento se resolverá como "http://onenoteapisamples.com/callback.php". +2. Coloque los archivos de ejemplo en el directorio raíz de su servidor web. +3. Abra un navegador y vaya a la página .php predeterminada. +4. Inicie sesión con su cuenta de Microsoft y permita que la aplicación cree páginas en los blocs de notas de OneNote. + +### Información de versión + + +### Información de versión + +| Fecha | Modificación | +|--------------|--------------------------------------------------------------------------------| +| mayo de 2017 | Actualizado para utilizar la URL base de Microsoft Graph v1.0 para recursos de OneNote | +| abril de 2017 | Actualizado para utilizar los puntos de conexión de la API de Microsoft Graph. | +| mayo de 2014 | Versión pública inicial para este ejemplo de código. | + +### Problemas conocidos + +- Si está ejecutando el ejemplo en un servidor web en una red doméstica, y no tiene una dirección IP fija y un nombre de dominio asignado, es posible que deba usar un proveedor DDNS y, a continuación, reenviar los puertos HTTP/S a su servidor local. +- Los archivos PHP en este ejemplo contienen finales de línea CRLF. Tendrá que conservar estos finales de línea cuando abra y edite estos archivos en el editor. Consulte [Manejo de finales de línea](https://help.github.com/articles/dealing-with-line-endings#platform-all) para obtener instrucciones sobre cómo conservar los finales de línea CRLF en todas las plataformas. + +### Más información + +- Visite el centro para desarrolladores [dev.onenote.com](http://dev.onenote.com) +- Póngase en contacto con nosotros en [StackOverflow (OneNote etiquetado)](http://go.microsoft.com/fwlink/?LinkID=390182) +- Síganos en [Twitter @onenotedev](http://www.twitter.com/onenotedev) +- Lea nuestro [Blog para desarrolladores de OneNote](http://go.microsoft.com/fwlink/?LinkID=390183) +- Pruebe la API usando el [Probador de Graph](https://developer.microsoft.com/es-es/graph/graph-explorer) +- Documentación de [referencia de API](https://developer.microsoft.com/es-es/graph/docs/api-reference/beta/resources/notes) +- [Problemas conocidos](https://developer.microsoft.com/es-es/graph/docs/overview/release_notes) +- [Introducción](https://developer.microsoft.com/es-es/graph/docs/get-started/get-started) a la API de Microsoft Graph + +Este proyecto ha adoptado el [Código de conducta de código abierto de Microsoft](https://opensource.microsoft.com/codeofconduct/). Para obtener más información, vea [Preguntas frecuentes sobre el código de conducta](https://opensource.microsoft.com/codeofconduct/faq/) o póngase en contacto con [opencode@microsoft.com](mailto:opencode@microsoft.com) si tiene otras preguntas o comentarios. diff --git a/README-Localized/Readme-fr-fr.md b/README-Localized/Readme-fr-fr.md new file mode 100644 index 0000000..ef76981 --- /dev/null +++ b/README-Localized/Readme-fr-fr.md @@ -0,0 +1,82 @@ +LISEZMOI de l’exemple PHP de OneNote API Microsoft Graph – Graphique +--------------------------------------------- + +Créé par Microsoft Corporation, 2017. Fourni en l’état sans garantie. Les marques mentionnées ici sont la propriété de leurs propriétaires. + +### Fonctionnalité de l’API illustrée dans cet exemple + +Les aspects suivants de l’API sont décrits dans cet exemple. Vous trouverez des informations supplémentaires via les liens ci-dessous. + +- [Connecter l'utilisateur](https://developer.microsoft.com/fr-fr/graph/docs/authorization/app_authorization) +- [OBTENIR les pages OneNote d’un utilisateur](https://developer.microsoft.com/fr-fr/graph/docs/api-reference/beta/api/page_get) +- [PUBLIER du simple HTML dans une nouvelle page OneNote QuickNotes](https://developer.microsoft.com/fr-fr/graph/docs/api-reference/beta/api/notes_post_pages) +- [PUBLIER un message en plusieurs parties avec des données d’image incluses dans la demande*](http://msdn.microsoft.com/fr-fr/library/office/dn575432.aspx) +- [PUBLIER une page avec une URL générée comme image*](http://msdn.microsoft.com/fr-fr/library/office/dn575431.aspx) +- [PUBLIER une page avec du HTML généré comme image*](http://msdn.microsoft.com/fr-fr/library/office/dn575432.aspx) +- [PUBLIER une page avec un fichier PDF généré et joint*](http://msdn.microsoft.com/fr-fr/library/office/dn655137.aspx) + +\* Indique la documentation pour les demandes de publication en plusieurs parties à l’API OneNote avant son intégration dans l’API Microsoft Graph – Graphique. La documentation relative aux exemples de demande décrits s’applique dès la production de cet exemple, mais sachez que des modifications peuvent être apportées prochainement. + +### Conditions préalables + +**Outils et bibliothèques** que vous devrez télécharger, installer et configurer pour votre environnement de développement. + +L’exemple PHP s’exécute sur un serveur Web. Le navigateur client doit pouvoir accéder au serveur Web pour terminer le protocole de transfert. Veillez à installer les fichiers PHP de manière que : + +- Le serveur Web que vous utilisez soit accessible à partir d’Internet +- PHP soit installé sur le serveur Web, avec le paquet cURL activé +- Vous ayez une URL normale avec nom d’hôte (et non une adresse IP uniquement) à utiliser pour l’URL de redirection. Si vous exécutez celle-ci à partir de votre ordinateur de bureau, vous devez modifier le fichier d’hôte (dans C:\\Windows\\System32\\drivers\\etc pour les ordinateurs Windows et /private/etc pour les ordinateurs Mac), puis mapper l’adresse IP de votre serveur local vers un nouveau nom de domaine, comme dans l’exemple suivant. ![Modifiez votre fichier hôte et mappez l’adresse IP de votre serveur local vers un nouveau nom de domaine](images/HostsFile.png) + +**Comptes** + +- En tant que développeur, vous devez [disposer d’un compte Microsoft et obtenir une chaîne d’ID client](http://msdn.microsoft.com/fr-fr/library/office/dn575426.aspx) pour votre application puisse s’authentifier avec le point de terminaison Microsoft Azure AD v2.0. +- En tant qu’utilisateur de l’exemple, vous devez posséder un compte Microsoft (Azure AD/ID d’organisation ou d’un compte MSA) pour que l’API OneNote puisse envoyer les pages vers votre espace OneDrive. + +### Inscrire l’exemple + +Une fois que vous avez configuré le serveur Web décrit ci-dessus,... + +1. Clonez le référentiel Git dans un dossier sur votre ordinateur local. +2. Accédez à la [page d’inscription des applications Microsoft](https://account.live.com/developers/applications/index). +3. Nous vous recommandons vivement de vous procurer votre propre ID client, clé secrète et URI de redirection. Vous pouvez vous procurer l’ID client, la clé secrète client et l’URI de redirection. [ici](http://developer.microsoft.com/fr-fr/graph/docs/authorization/auth_register_app_v2) +4. Pour le développement local, l’exemple utilise http://localhost:8888/callback.php comme URI de redirection. Pour la production, vous devez modifier ce protocole pour qu'il pointe vers votre domaine d'application sur le déploiement hébergé. Si l’URL du déploiement racine est https://onenoteapisamples.com, alors spécifiez https://onenoteapisamples.com/callback.php comme URL de redirection (comme dans l’exemple suivant). Cette URL doit correspondre exactement à l’URL de redirection déployée. Le nom de domaine racine doit être unique. Par conséquent, si vous utilisez un domaine à des fins de test et un autre pour la production, vous devez inscrire des ID clients distincts et des clés secrètes pour chaque domaine.[Spécifiez les paramètres de l’API dans le portail d’inscription des applications Microsoft](images/OneNoteMSAScreen.png) +>Remarque : Chrome et Firefox n'autorisent pas l'installation de cookies sur localhost. De ce fait, l'authentification ne fonctionne pas sur ces navigateurs pendant le développement si vous choisissez de vous rediriger vers localhost. + +### Configurer l’exemple + +1. Remplacez les espaces réservés suivants dans les fichiers callback.php et index.php avec les valeurs associées à partir de la page Paramètres de l’application : + 1. Remplacez CLIENT\_ID par la valeur ID client. + 2. Remplacez CLIENT\_SECRET par la valeur de clé secrète client. + 3. Remplacez REDIRECT\_URI\_PATH par la valeur de l’URL racine de déploiement. L’URL racine de déploiement se compose de « http:// » et l’URL de domaine racine. Par conséquent, si votre URL de redirection ressemble à http://onenoteapisamples.com/callback.php, l’URL racine de déploiement est « http://onenoteapisamples.com ». Au moment de l’exécution, la valeur de l’URL de redirection correspond à « http://onenoteapisamples.com/callback.php ». +2. Mettez les fichiers d'exemple dans le répertoire racine de votre serveur web. +3. Ouvrez un navigateur et accédez à la page .php par défaut. +4. Connectez-vous à l’aide du compte Microsoft et autorisez l’application à créer des pages dans vos blocs-notes OneNote. + +### Informations relatives à la version + + +### Informations relatives à la version + +| Date | Modifier | +|--------------|--------------------------------------------------------------------------------| +| Mai 2017 | Mise à jour pour utiliser l'URL de base de Microsoft Graph – Graphique v1.0 pour les ressources OneNote | +| Avril 2017 | Mise à jour pour utiliser les points de terminaison de l'API de Microsoft Graph. | +| Mai 2014 | Version publique initiale de cet exemple de code. | + +### Problèmes connus + +- Si vous exécutez l’exemple sur un serveur Web sur un réseau domestique et que vous n’avez pas d’adresse IP fixe et de nom de domaine attribué, vous devez peut-être utiliser un fournisseur DDNS, puis transférer les ports HTTP/S vers votre serveur local. +- Dans cet exemple, les fichiers PHP contiennent des fins de ligne CRLF. Vous devez conserver ces fins de ligne lorsque vous ouvrez et modifiez ces fichiers dans votre éditeur. Consultez la rubrique [Traitement des fins de ligne](https://help.github.com/articles/dealing-with-line-endings#platform-all) pour savoir comment conserver les fins de ligne CRLF sur toutes les plateformes. + +### Pour en savoir plus + +- Visitez le centre de développement [dev.onenote.com](http://dev.onenote.com) +- Contactez-nous sur [StackOverflow (avec la balise OneNote)](http://go.microsoft.com/fwlink/?LinkID=390182) +- Suivez-nous sur [Twitter @onenotedev](http://www.twitter.com/onenotedev) +- Lisez notre [blog de OneNote pour les développeurs](http://go.microsoft.com/fwlink/?LinkID=390183) +- Explorez l’API à l’aide de l’[Afficheur Graph – Graphique](https://developer.microsoft.com/fr-fr/graph/graph-explorer) +- Documentation de [référence d’API](https://developer.microsoft.com/fr-fr/graph/docs/api-reference/beta/resources/notes) +- [Problèmes connus](https://developer.microsoft.com/fr-fr/graph/docs/overview/release_notes) +- [Prise en main](https://developer.microsoft.com/fr-fr/graph/docs/get-started/get-started) de l’API Microsoft Graph + +Ce projet a adopté le [code de conduite Open Source de Microsoft](https://opensource.microsoft.com/codeofconduct/). Pour en savoir plus, reportez-vous à la [FAQ relative au code de conduite](https://opensource.microsoft.com/codeofconduct/faq/) ou contactez [opencode@microsoft.com](mailto:opencode@microsoft.com) pour toute question ou tout commentaire. diff --git a/README-Localized/Readme-ja-jp.md b/README-Localized/Readme-ja-jp.md new file mode 100644 index 0000000..00c9571 --- /dev/null +++ b/README-Localized/Readme-ja-jp.md @@ -0,0 +1,82 @@ +Microsoft Graph OneNote API PHP のサンプル README +--------------------------------------------- + +作成: Microsoft Corporation、2017。現状のまま提供され、保証はいたしません。ここに記載される商標は、商標の所有者の所有物です。 + +### このサンプルでデモンストレーションを行う API 機能 + +このサンプルでは、API の以下の点について説明します。その他の資料については、以下のリンクを参照してください。 + +- [ユーザーをログインする](https://developer.microsoft.com/ja-jp/graph/docs/authorization/app_authorization) +- [ユーザーの OneNote ページを GET する](https://developer.microsoft.com/ja-jp/graph/docs/api-reference/beta/api/page_get) +- [シンプルな HTML を新しい OneNote のクイック ノート ページに POST する](https://developer.microsoft.com/ja-jp/graph/docs/api-reference/beta/api/notes_post_pages) +- [要求に含まれている、画像データが含まれるマルチパート メッセージを POST する*](http://msdn.microsoft.com/ja-jp/library/office/dn575432.aspx) +- [画像としてレンダリングされた URL が含まれるページを POST する*](http://msdn.microsoft.com/ja-jp/library/office/dn575431.aspx) +- [画像としてレンダリングされた HTML が含まれるページを POST する*](http://msdn.microsoft.com/ja-jp/library/office/dn575432.aspx) +- [レンダリングされ添付された PDF が含まれるページを POST する*](http://msdn.microsoft.com/ja-jp/library/office/dn655137.aspx) + +\* OneNote API が Microsoft Graph API に統合される以前の、OneNote API に対するマルチパート POST 要求に関するドキュメントであることを示します。説明されている要求サンプルのドキュメントはこのサンプルの作成時点では有効ですが、今後変更される可能性がありますので注意してください。 + +### 前提条件 + +ダウンロードしてインストールし、開発環境に合わせて構成する必要がある**ツールおよびライブラリ**。 + +PHP サンプルは Web サーバーで実行されます。ハンドシェイクを完了できるよう、クライアント ブラウザーは Web サーバーにアクセスできる必要があります。以下のことを可能にするために、PHP ファイルを必ずインストールします。 + +- 使用している Web サーバーにインターネットからアクセスできる。 +- Web サーバーに PHP がインストールされていて、cURL パッケージが有効になっている +- リダイレクト URL に使用するための、(IP アドレスだけではなく) ホスト名を持つ通常の URL がある。このサンプルを自分のデスクトップから実行する場合は、下の例に示すように、Hosts ファイル (Windows コンピューターの場合は C:\\Windows\\System32\\drivers\\etc、Mac の場合は /private/etc) を変更し、ローカル サーバーの IP アドレスを新しいドメイン名にマッピングする必要があります。![Hosts ファイルを変更し、ローカル サーバーの IP アドレスを新しいドメイン名にマッピングする](images/HostsFile.png) + +**アカウント** + +- アプリが Microsoft Azure AD v2.0 エンドポイントを使用して認証を行うことを許可できるよう、開発者は [Microsoft アカウントを所有し、クライアント ID 文字列を取得する](http://msdn.microsoft.com/ja-jp/library/office/dn575426.aspx)必要があります。 +- サンプルのユーザーは、OneNote API がユーザーの OneDrive にページを送信できるよう、Microsoft アカウント(Azure AD と組織 ID または MSA アカウント)が必要です。 + +### サンプルを登録する + +上記のとおり Web サーバーを設定したら、以下の手順を実行します。 + +1. Git リポジトリをローカル コンピューター上のフォルダーに複製します。 +2. [Microsoft アプリ登録ページ](https://account.live.com/developers/applications/index)にアクセスします。 +3. 独自のクライアント ID、シークレット、およびリダイレクト URI を取得することを強くお勧めします。独自のクライアント ID、クライアント シークレット、リダイレクト URI は[こちら](http://developer.microsoft.com/ja-jp/graph/docs/authorization/auth_register_app_v2)から取得できます。 +4. ローカルで開発する場合は、サンプルではリダイレクト URI として http://localhost:8888/callback.php が使用されます。運用環境では、ホスト型展開環境内のアプリケーションのドメインをポイントするように URI を変更する必要があります。ルート展開 URL が https://onenoteapisamples.com である場合は、下の例に示すように、リダイレクト URL として https://onenoteapisamples.com/callback.php を指定します。この URL は、展開されているリダイレクト URL と完全に一致する必要があります。ルート ドメイン名は一意のものである必要があります。このため、テスト用にドメインを 1 つ使用し、運用環境用に別のドメインを使用する場合、各ドメインについて別々のクライアント ID とシークレットを登録する必要があります。[Specify API settings in the Microsoft Application Registration Portal (Microsoft アプリケーション登録ポータルで API 設定を指定する)](images/OneNoteMSAScreen.png) +>注:Chrome と Firefox では Cookie を localhost にセットできないため、localhost にリダイレクトするように設定した場合、開発中はこれらのブラウザーでは認証が機能しません。 + +### サンプルをセットアップする + +1. callback.php と index.php ファイル内の次のプレースホルダーを、アプリ設定ページからの関連値で置き換えます。 + 1. CLIENT\_ID をクライアント ID 値で置き換えます。 + 2. CLIENT\_SECRET をクライアント シークレット値で置き換えます。 + 3. REDIRECT\_URI\_PATH を展開ルート URL の値で置き換えます。展開ルート URL は "http://" とルート ドメイン URL により構成されるため、リダイレクト URL は "http://onenoteapisamples.com/callback.php" のようになり、展開ルート URL は "http://onenoteapisamples.com" となります。 実行時、リダイレクト URL 値は "http://onenoteapisamples.com/callback.php" に解決されます。 +2. サンプル ファイルを Web サーバーのルート ディレクトリに置きます。 +3. ブラウザーを開き、デフォルトの .php ページに移動します。 +4. Microsoft アカウントを使用してログインし、アプリが OneNote ノートブック内にページを作成することを許可します。 + +### バージョン情報 + + +### バージョン情報 + +| 日付 | 変更点 | +|--------------|--------------------------------------------------------------------------------| +| 2017 年 5 月 | OneNote リソース用に Microsoft Graph v1.0 ベース URL を利用するように更新。 | +| 2017 年 4 月 | Microsoft Graph API エンドポイントを利用するように更新。 | +| 2014 年 5 月 | 本コード サンプルの最初のパブリック リリース。 | + +### 既知の問題 + +- このサンプルをホーム ネットワーク上の Web サーバーで実行する場合に固定 IP アドレスと割当済みのドメイン名を持っていない場合、DDNS プロバイダーを使用し、HTTP/S ポートをローカル サーバーに転送する必要がある場合があります。 +- このサンプルの PHP ファイルには、CRLF の行末が含まれています。これらのファイルをエディターで開いて編集する場合は、これらの行末を維持する必要があります。すべてのプラットフォームで CRLF の行末を維持する方法については、「[Dealing with line endings (行末の取り扱い)](https://help.github.com/articles/dealing-with-line-endings#platform-all)」を参照してください。 + +### その他のリソース + +- [dev.onenote.com](http://dev.onenote.com) デベロッパー センターをご覧ください +- [StackOverflow (tagged OneNote)](http://go.microsoft.com/fwlink/?LinkID=390182) でご質問を受け付けています +- Twitter でフォローしてください ([@onenotedev](http://www.twitter.com/onenotedev)) +- [OneNote の開発者ブログ](http://go.microsoft.com/fwlink/?LinkID=390183)をご覧ください +- [Graph エクスプローラー](https://developer.microsoft.com/ja-jp/graph/graph-explorer)を使用して API をより深く知ってください +- [API リファレンス](https://developer.microsoft.com/ja-jp/graph/docs/api-reference/beta/resources/notes) ドキュメント +- [既知の問題](https://developer.microsoft.com/ja-jp/graph/docs/overview/release_notes) +- Microsoft Graph API の[使用を開始する](https://developer.microsoft.com/ja-jp/graph/docs/get-started/get-started) + +このプロジェクトでは、[Microsoft Open Source Code of Conduct (Microsoft オープン ソース倫理規定)](https://opensource.microsoft.com/codeofconduct/) が採用されています。詳細については、「[Code of Conduct の FAQ (倫理規定の FAQ)](https://opensource.microsoft.com/codeofconduct/faq/)」を参照してください。また、その他の質問やコメントがあれば、[opencode@microsoft.com](mailto:opencode@microsoft.com) までお問い合わせください。 diff --git a/README-Localized/Readme-pt-br.md b/README-Localized/Readme-pt-br.md new file mode 100644 index 0000000..58cd5be --- /dev/null +++ b/README-Localized/Readme-pt-br.md @@ -0,0 +1,82 @@ +Exemplo de API do Microsoft Graph OneNote em PHP LEIAME +--------------------------------------------- + +Criado pela Microsoft Corporation, 2017. Fornecido como está sem garantia. As marcas comerciais mencionadas aqui pertencem aos proprietários. + +### Funcionalidade da API demonstrada neste exemplo + +Os seguintes aspectos da API são abordados nesta amostra. Para saber mais, confira os links abaixo. + +- [Log in do usuário](https://developer.microsoft.com/pt-br/graph/docs/authorization/app_authorization) +- [OBTER páginas do OneNote do usuário](https://developer.microsoft.com/pt-br/graph/docs/api-reference/beta/api/page_get) +- [POSTAR HTML simples em uma nova página do OneNote QuickNotes](https://developer.microsoft.com/pt-br/graph/docs/api-reference/beta/api/notes_post_pages) +- [POSTAR mensagem de várias partes com dados de imagem incluídos na solicitação \*](http://msdn.microsoft.com/pt-br/library/office/dn575432.aspx) +- [Página de POSTAGEM com uma URL processada como uma imagem \*](http://msdn.microsoft.com/pt-br/library/office/dn575431.aspx) +- [Página de POSTAGEM com uma HTML processada como uma imagem \*](http://msdn.microsoft.com/pt-br/library/office/dn575432.aspx) +- [Página de POSTAGEM com um arquivo PDF renderizado e anexado \*](http://msdn.microsoft.com/pt-br/library/office/dn655137.aspx) + +\* Indica a documentação para as solicitações de POSTAGEM de várias partes da API do OneNote antes de sua integração com a API do Microsoft Graph. A documentação dos exemplos de solicitação contornadas funciona a partir da produção desse exemplo, mas lembre-se de que as alterações podem ser futuras. + +### Pré-requisitos + +Será necessário baixar, instalar e configurar**Ferramentas e Bibliotecas** para o seu ambiente de desenvolvimento. + +A amostra de PHP é executada em um servidor da Web. O navegador cliente deve ser capaz de acessar o servidor Web para concluir o handshake. Certifique-se de instalar os arquivos PHP para que: + +- O servidor Web que você está usando possa ser acessado na Internet +- O servidor Web tem o PHP instalado, com o pacote ondulado habilitado +- Você tem uma URL normal com o nome do host (não apenas um endereço IP) para usar para a URL de redirecionamento. Se você executar isso a partir da sua própria área de trabalho, precisará modificar o seu arquivo hosts (no C:\\Windows\\System32\\drivers\\etc para computadores Windows e /private/etc para Macs) e mapear o endereço IP do servidor local para um novo nome de domínio, como no exemplo a seguir. ![Modificar o seu arquivo hosts e mapear o endereço IP do servidor local para um novo nome de domínio](images/HostsFile.png) + +**Contas** + +- Como desenvolvedor, você precisará [ter uma conta da Microsoft e obter uma cadeia de caracteres de ID do cliente](http://msdn.microsoft.com/pt-br/library/office/dn575426.aspx), para que seu aplicativo possa ser autenticado com o ponto de extremidade do Microsoft Azure AD v2.0. +- Como usuário do exemplo, você precisará de uma conta da Microsoft (ID do Azure AD/Org ou uma conta do MSA) para que a API do OneNote possa enviar as páginas para o OneDrive. + +### Registrar a amostra + +Depois de configurar seu servidor Web descrito acima,.... + +1. Clonar o repositório Git para uma pasta em seu computador local. +2. Visite a [página de registro do aplicativo da Microsoft](https://account.live.com/developers/applications/index). +3. É altamente recomendável que você obtenha seu próprio ID de cliente, segredo e URI de redirecionamento. Você pode obter sua ID de cliente, o segredo do cliente e o URI de redirecionamento. [aqui](http://developer.microsoft.com/pt-br/graph/docs/authorization/auth_register_app_v2) +4. Para o desenvolvimento local, o exemplo usa o http://localhost:8888/callback.php como URI de redirecionamento. Para produção, você deve alterar isso para apontar para o domínio do aplicativo na implantação hospedada. Se a URL de implantação raiz for https://onenoteapisamples.com, especifique https://onenoteapisamples.com/callback.php como a URL de redirecionamento (como no exemplo a seguir). Essa URL deve corresponder exatamente à URL de redirecionamento implantada. O nome de domínio raiz deve ser exclusivo, portanto, se você usar um domínio para teste e outro para produção, será necessário registrar identificações de cliente e segredos separados para cada domínio.[especificar as configurações da API no portal de registro de aplicativo da Microsoft](images/OneNoteMSAScreen.png) +>Observação: O Chrome e o Firefox não permitem que os cookies sejam configurados no localhost, e a autenticação não funcionará nesses navegadores durante o desenvolvimento, caso você opte por redirecionar para o localhost. + +### Configurar a amostra + +1. Substitua os seguintes espaços reservados nos arquivos callback.php e index.php pelos valores associados na página configurações do aplicativo: + 1. Substitua CLIENT\_ID pelo valor ID do cliente. + 2. Substitua CLIENT\_SECRET pelo valor de segredo do cliente. + 3. Substituir REDIRECT\_URI\_PATH pelo valor da URL raiz da implantação. A URL raiz da implantação consiste em "http://", além da URL do domínio raiz, portanto, se a URL de redirecionamento for igual a http://onenoteapisamples.com/callback.php, a URL raiz da implantação será "http://onenoteapisamples.com". Em tempo de execução, o valor da URL de redirecionamento será resolvido para "http://onenoteapisamples.com/callback.php". +2. Coloque os arquivos de exemplo no diretório raiz do seu servidor da Web. +3. Abra um navegador e navegue até a página padrão .php. +4. Faça logon usando sua conta da Microsoft e permita que o aplicativo crie páginas em seus blocos de anotações do OneNote. + +### Informações de versão + + +### Informações de versão + +| Data | Alterar | +|------------|--------------------------------------------------------------------------------| +| Maio de 2017 | Atualizado para usar o Microsoft Graph v1.0 URL base para recursos do OneNote | +| Abril de 2017 | Atualizado para utilizar os pontos de extremidade de API do Microsoft Graph. | +| Maio de 2014 | Versão pública inicial deste exemplo de código. | + +### Problemas conhecidos + +- Se você estiver executando o exemplo em um servidor da Web em uma rede doméstica e não tiver um endereço IP fixo e um nome de domínio atribuídos, talvez seja necessário usar um provedor de DDNS e encaminhar as portas HTTP/S para o servidor local. +- Os arquivos PHP neste exemplo contêm CRLF terminações de linha. Será preciso manter essas terminações de linha ao abrir e editar esses arquivos em seu editor. Confira [lidando com terminações de linha](https://help.github.com/articles/dealing-with-line-endings#platform-all) para obter orientação sobre como reter as terminações de linha CRLF em todas as plataformas. + +### Saiba mais + +- Visite o centro de desenvolvimento do[dev.onenote.com](http://dev.onenote.com) +- Fale conosco na [StackOverflow (marcado OneNote)](http://go.microsoft.com/fwlink/?LinkID=390182) +- Siga-nos em [@onenotedev Twitter](http://www.twitter.com/onenotedev) +- Leia nosso blog [OneNote Developer](http://go.microsoft.com/fwlink/?LinkID=390183) +- Explore as API usando o [Explorador do Graph](https://developer.microsoft.com/pt-br/graph/graph-explorer) +- Documentação de [referência da API](https://developer.microsoft.com/pt-br/graph/docs/api-reference/beta/resources/notes) +- [Problemas conhecidos](https://developer.microsoft.com/pt-br/graph/docs/overview/release_notes) +- [Introdução](https://developer.microsoft.com/pt-br/graph/docs/get-started/get-started) com a API do Microsoft Graph + +Este projeto adotou o [Código de conduta do código-fonte da Microsoft Open](https://opensource.microsoft.com/codeofconduct/). Para saber mais, confira as [Perguntas frequentes sobre o Código de Conduta](https://opensource.microsoft.com/codeofconduct/faq/) ou entre em contato pelo [opencode@microsoft.com](mailto:opencode@microsoft.com) se tiver outras dúvidas ou comentários. diff --git a/README-Localized/Readme-ru-ru.md b/README-Localized/Readme-ru-ru.md new file mode 100644 index 0000000..09adff6 --- /dev/null +++ b/README-Localized/Readme-ru-ru.md @@ -0,0 +1,82 @@ +Microsoft Graph OneNote API Пример PHP для чтения +--------------------------------------------- + +Создано Microsoft Corporation, 2017. Предоставляется как есть без гарантии. Товарные знаки, упомянутые в этой статье, являются собственностью их владельцев. + +### Функции API, демонстрируются в этом примере + +В этом примере рассматриваются указанные ниже аспекты API. Дополнительные сведения можно найти по ссылкам ниже. + +- [Вход в систему пользователя](https://developer.microsoft.com/ru-ru/graph/docs/authorization/app_authorization) +- [ПОЛУЧИТЕ страницы пользователя OneNote](https://developer.microsoft.com/ru-ru/graph/docs/api-reference/beta/api/page_get) +- [Отправьте простой HTML на новую страницу быстрых заметок OneNote](https://developer.microsoft.com/ru-ru/graph/docs/api-reference/beta/api/notes_post_pages) +- [POST-сообщение из нескольких частей с данными изображения, включенными в запрос \*](http://msdn.microsoft.com/ru-ru/library/office/dn575432.aspx) +- [Страница POST с URL, отображаемым как изображение \*](http://msdn.microsoft.com/ru-ru/library/office/dn575431.aspx) +- [Страница POST с HTML, отображаемым как изображение \*](http://msdn.microsoft.com/ru-ru/library/office/dn575432.aspx) +- [Страница POST с файлом PDF, представленным и прикрепленным \*](http://msdn.microsoft.com/ru-ru/library/office/dn655137.aspx) + +\* Указывает на документацию для POST-запросов, состоящих из нескольких частей, к API OneNote перед его интеграцией в Microsoft Graph API. Документация для приведенных примеров запросов работает на момент создания этого образца, но следует помнить, что возможны изменения. + +### Необходимые компоненты + +**Инструменты и Библиотеки** которые вам потребуется скачать, установить и настроить для вашей среды разработки. + +Пример PHP работает на веб-сервере. Клиентский браузер должен иметь доступ к веб-серверу для завершения рукопожатия. Убедитесь, что вы установили файлы PHP так, чтобы: + +- Используемый вами веб-сервер доступен из Интернета. +- На веб-сервере установлен PHP с включенным пакетом cURL +- У вас есть обычный URL с именем хоста (а не просто IP-адресом), который можно использовать для URL перенаправления. При запуске этого приложения на рабочем столе потребуется изменить файл hosts (в C:\\Windows\\System32\\drivers\\etc для компьютеров с Windows и/привате/ЕТК для компьютеров Mac) и сопоставить IP-адреса локального сервера с новым доменным именем, как показано в приведенном ниже примере. ![Измените файл Hosts и сопоставьте IP-адрес локального сервера с новым доменным именем.](images/HostsFile.png) + +**Учетные записи** + +- Как разработчик, вам нужно [иметь учетную запись Microsoft и получить строку идентификатора клиента](http://msdn.microsoft.com/ru-ru/library/office/dn575426.aspx), чтобы ваше приложение могло проходить аутентификацию с помощью конечной точки Microsoft Azure AD v2.0. +- В качестве пользователя примера вам понадобится учетная запись Microsoft (Azure AD / Org ID или учетная запись MSA), чтобы API OneNote мог отправлять страницы в OneDrive. + +### Зарегистрировать образец + +После настройки вашего веб-сервера, описанного выше,.... + +1. Клонируйте Git-репозиторий в папку на вашем локальном компьютере. +2. Перейдите на страницу [регистрации приложения Microsoft](https://account.live.com/developers/applications/index). +3. Настоятельно рекомендуется получить свой собственный идентификатор клиента, секретный и URI перенаправления. Вы можете получить свой собственный идентификатор клиента, секрет клиента и URI перенаправления. [здесь](http://developer.microsoft.com/ru-ru/graph/docs/authorization/auth_register_app_v2) +4. Для локальной разработки образец использует http://localhost:8888/callback.php в качестве URI перенаправления. Для производства вы должны изменить это так, чтобы он указывал на домен вашего приложения при размещении на хосте. Если корневым URL-адресом развертывания является https://onenoteapisamples.com, укажите https://onenoteapisamples.com/callback.php в качестве URL-адреса перенаправления (как в следующем примере). Этот URL должен точно соответствовать развернутому URL перенаправления. Имя корневого домена должно быть уникальным, поэтому, если вы используете один домен для тестирования, а другой для производства, вам необходимо зарегистрировать отдельные идентификаторы и секреты клиента для каждого домена. [Укажите настройки API на портале регистрации приложений Microsoft](images/OneNoteMSAScreen.png). +>Примечание. Chrome и Firefox не позволяют устанавливать файлы cookie на локальном хосте, и поэтому аутентификация не будет работать в этих браузерах во время разработки, если вы решите перенаправить на локальный хост. + +### Настройте образец + +1. Замените следующие заполнители в файлах callback.php и index.php соответствующими значениями на странице настроек приложения: + 1. Замените CLIENT\_ID значением идентификатора клиента. + 2. Замените CLIENT\_SECRET на секретное значение клиента. + 3. Замените REDIRECT\_URI\_PATH значением корневого URL-адреса развертывания. URL-адрес развертывания состоит из "http://" и URL-адреса корневого домена, поэтому если URL-адрес перенаправления выглядит так http://onenoteapisamples.com/callback.php, URL-адрес развертывания — "http://onenoteapisamples.com". Во время выполнения значение URL-адреса перенаправления преобразуется в «http://onenoteapisamples.com/callback.php». +2. Поместите образцы файлов в корневой каталог на вашем веб-сервере. +3. Откройте браузер и перейдите на страницу .php по умолчанию. +4. Войдите в систему, используя свою учетную запись Microsoft, и позвольте приложению создавать страницы в своих записных книжках OneNote. + +### Сведения о версии + + +### Сведения о версии + +| Дата | Изменить | +| -------------- | ---------------------------------- ---------------------------------------------- | +| Май 2017 | Обновлено для использования базового URL-адреса Microsoft Graph v1.0 для ресурсов OneNote | +| Апрель 2017 | Обновлен для использования конечных точек Microsoft Graph API. | +| Май 2014 | Первоначальный публичный релиз для этого примера кода. | + +### Известные проблемы + +- Если вы запускаете образец на веб-сервере в домашней сети и у вас нет фиксированного IP-адреса и назначенного доменного имени, вам может потребоваться использовать поставщика DDNS, а затем перенаправить порты HTTP / S на ваш локальный сервер. +- Файлы PHP в этом примере содержат окончания строк CRLF. Вам нужно будет сохранить эти окончания строк при открытии и редактировании этих файлов в редакторе. См. [Работа с окончаниями строк](https://help.github.com/articles/dealing-with-line-endings#platform-all) для получения инструкций о том, как сохранить окончания строк CRLF на всех платформах. + +### Учиться больше + +- Посетить центр разработчиков [dev.onenote.com](http://dev.onenote.com) +- Свяжитесь с нами на сайте [StackOverflow (тег OneNote)](http://go.microsoft.com/fwlink/?LinkID=390182) +- Подпишитесь на нас в [Twitter @onenotedev](http://www.twitter.com/onenotedev) +- Читайте наш [блог для разработчиков OneNote](http://go.microsoft.com/fwlink/?LinkID=390183) +- Исследуйте API с помощью [Graph Explorer](https://developer.microsoft.com/ru-ru/graph/graph-explorer) +- [Справочная документация по API](https://developer.microsoft.com/ru-ru/graph/docs/api-reference/beta/resources/notes) +- [Известные проблемы](https://developer.microsoft.com/ru-ru/graph/docs/overview/release_notes) +- [Начало работы](https://developer.microsoft.com/ru-ru/graph/docs/get-started/get-started) с Microsoft Graph API + +Этот проект соответствует [Правилам поведения разработчиков открытого кода Майкрософт](https://opensource.microsoft.com/codeofconduct/). Дополнительные сведения см. в разделе [часто задаваемых вопросов о правилах поведения](https://opensource.microsoft.com/codeofconduct/faq/). Если у вас возникли вопросы или замечания, напишите нам по адресу [opencode@microsoft.com](mailto:opencode@microsoft.com). diff --git a/README-Localized/Readme-zh-cn.md b/README-Localized/Readme-zh-cn.md new file mode 100644 index 0000000..ecaf670 --- /dev/null +++ b/README-Localized/Readme-zh-cn.md @@ -0,0 +1,82 @@ +Microsoft Graph OneNote API PHP 示例自述文件 +--------------------------------------------- + +由 Microsoft Corporation 创建,2017。按原样提供,不做保证。此处提及的商标是其所有者的财产。 + +### 此示例中演示的 API 功能 + +本示例介绍了 API 的以下方面。可在下面链接中找到附加文档。 + +- [登录用户](https://developer.microsoft.com/zh-cn/graph/docs/authorization/app_authorization) +- [获取用户的 OneNote 页面](https://developer.microsoft.com/zh-cn/graph/docs/api-reference/beta/api/page_get) +- [向新 OneNote QuickNotes 页面发布简单的 HTML](https://developer.microsoft.com/zh-cn/graph/docs/api-reference/beta/api/notes_post_pages) +- [发布含请求中所包含图像数据的多部分消息 \*](http://msdn.microsoft.com/zh-cn/library/office/dn575432.aspx) +- [发布呈现为图像的 URL*](http://msdn.microsoft.com/zh-cn/library/office/dn575431.aspx) +- [发布呈现为图像的 HTML*](http://msdn.microsoft.com/zh-cn/library/office/dn575432.aspx) +- [发布含有呈现和附加的 PDF 文件页面*](http://msdn.microsoft.com/zh-cn/library/office/dn655137.aspx) + +\* 表示集成至 Microsoft Graph API 前,针对 OneNote API 的多部份 POST 请求文档。分级式请求示例的文档适用于此示例的生产,但可能会发生更改。 + +### 先决条件 + +针对开发环境,需要下载、安装并配置**工具和库**。 + +PHP 示例在 web 服务器上运行。客户端浏览器需要能够访问 web 服务器以完成握手。请确保安装了 PHP 文件,以便: + +- 可以从 Internet 访问 web 服务器 +- web 服务器已安装了 PHP,并启用了 cURL 包 +- 你拥有一个普通 URL,其中含有用于重定向 URL 的主机名(不仅仅是 IP 地址)。如果从桌面运行此操作,需要修改 Hosts 文件(对于Windows 计算机在 C:\\Windows\\System32\\drivers\\etc 中,对于 Mac 在 /private/etc 中),并将本地服务器 IP 地址映射到新域名,具体如下例所示。![修改 Hosts 文件并将本地服务器 IP 地址映射到新域名](images/HostsFile.png) + +**帐户** + +- 作为开发人员,你将需要 [拥有 Microsoft 帐户,并获取客户端 ID 字符串](http://msdn.microsoft.com/zh-cn/library/office/dn575426.aspx),以便通过 Microsoft Azure AD v 2.0 端点对应用程序进行身份验证。 +- 作为示例用户,需要 Microsoft 帐户(Azure AD/组织 ID 或 MSA 帐户) 才能使 OneNote API 将页面发送到你的 OneDrive。 + +### 注册示例 + +设置完上述 web 服务器后.... + +1. 克隆 Git 存储库至本地计算机的文件夹。 +2. 转到 [Microsoft 应用注册页面](https://account.live.com/developers/applications/index)。 +3. 强烈建议获取自己的客户端 ID、密码和重新向 URL。你可获取自己的客户端 ID、密码和重新向 URL。[点击这里](http://developer.microsoft.com/zh-cn/graph/docs/authorization/auth_register_app_v2) +4. 对于本地开发,示例使用 http://localhost:8888/callback.php 作为重定向 URI。对于生产,应将其更改为指向托管部署上的应用程序域。如果根部署 URL是 https://onenoteapisamples.com,随后指定 https://onenoteapisamples.com/callback.php 作为重定向 URL(如下列示例所示)。此 URL 必须与部署的重定向 URL 完全匹配。根域名必须唯一,因此如果将一个域用于测试,另一个用于生产,则需要为每个域注册单独的客户端 ID 和密码。[在 Microsoft 应用注册门户中指定 API 设置](images/OneNoteMSAScreen.png) +>注意:Chrome 和 Firefox 不允许对 localhost 设置 cookie,因此如果选择重定向到 localhost,则在开发过程中无法对这些浏览器进行身份验证。 + +### 设置示例 + +1. 使用应用程序设置页面中的相关值替换 callback.php 和 index.php 文件中的下列占位符: + 1. 使用客户端 ID 值替换 CLIENT\_ID。 + 2. 使用客户端密码值替换 CLIENT\_SECRET。 + 3. 使用部署根 URL 替换 REDIRECT\_URI\_PATH。部署根 URL 由 "http://" 和根域 URL 组成,因此如果重定向像 http://onenoteapisamples.com/callback.php 这样的URL,部署根 URL 为 "http://onenoteapisamples.com"。 运行时,重定向 URL 值将解析为 "http://onenoteapisamples.com/callback.php"。 +2. 将示例文件放在 web 服务器的根目录中。 +3. 打开浏览器并导航至默认 .php 页面。 +4. 使用 Microsoft 账户登录,并允许应用程序在你的 OneNote 笔记本中创建页面。 + +### 版本信息 + + +### 版本信息 + +|日期 |更改 | +|--------------|--------------------------------------------------------------------------------| +| 2017年5月 | 更新以利用适用于 OneNote 资源的 Microsoft Graph v 1.0 基准 URL | +| 2017 年 4 月 | 更新以利用 Microsoft Graph API 端点。| +| 2014 年 5 月| 此代码示例的初始公共发布。| + +### 已知问题 + +- 如果正在家庭网络上的 web 服务器上运行示例,且没有固定的 IP 地址和分配的域名,可能需要使用 DDNS 提供商,然后将 HTTP/S 端口转发到本地服务器。 +- 此示例中的 PHP 文件包含 CRLF 行结尾。在编辑器中打开和编辑这些文件时,需保留这些行结尾。有关如何在所有平台上保留 CRLF 行结尾的指南,请参阅“[处理行尾](https://help.github.com/articles/dealing-with-line-endings#platform-all)”。 + +### 了解更多内容 + +- 访问 [dev.onenote.com](http://dev.onenote.com) 开发中心 +- 访问 [StackOverflow(已标记的 OneNote)](http://go.microsoft.com/fwlink/?LinkID=390182)联系我们 +- 在 [Twitter @onenotedev](http://www.twitter.com/onenotedev) 中关注我们 +- 阅读我们的 [OneNote 开发者博客](http://go.microsoft.com/fwlink/?LinkID=390183) +- 请在 [Graph 浏览器](https://developer.microsoft.com/zh-cn/graph/graph-explorer)中探索 API +- [API 参考](https://developer.microsoft.com/zh-cn/graph/docs/api-reference/beta/resources/notes)文档 +- [已知问题](https://developer.microsoft.com/zh-cn/graph/docs/overview/release_notes) +- Microsoft Graph API [入门](https://developer.microsoft.com/zh-cn/graph/docs/get-started/get-started) + +此项目已采用 [Microsoft 开放源代码行为准则](https://opensource.microsoft.com/codeofconduct/)。有关详细信息,请参阅[行为准则常见问题解答](https://opensource.microsoft.com/codeofconduct/faq/)。如有其他任何问题或意见,也可联系 [opencode@microsoft.com](mailto:opencode@microsoft.com)。